Skip to content

Commit

Permalink
make docs point to ecosystem wide docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Oct 20, 2023
1 parent 5b9be60 commit ada46a7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "StateSpaceSets"
uuid = "40b095a5-5852-4c12-98c7-d43bf788e795"
authors = ["George Datseris <[email protected]>"]
repo = "https://github.com/JuliaDynamics/StateSpaceSets.jl.git"
version = "1.4.4"
version = "1.4.5"

[deps]
Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
Expand Down
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,19 @@
# StateSpaceSets.jl

[![](https://img.shields.io/badge/docs-dev-lightblue.svg)](https://JuliaDynamics.github.io/StateSpaceSets.jl/dev)
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaDynamics.github.io/StateSpaceSets.jl/stable)
[![docsdev](https://img.shields.io/badge/docs-dev-lightblue.svg)](https://juliadynamics.github.io/DynamicalSystemsDocs.jl/statespacesets/dev/)
[![docsstable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliadynamics.github.io/DynamicalSystemsDocs.jl/statespacesets/stable/)
[![](https://img.shields.io/badge/DOI-10.1007%2F978--3--030--91032--7-purple)](https://link.springer.com/book/10.1007/978-3-030-91032-7)
[![CI](https://github.com/JuliaDynamics/StateSpaceSets.jl/workflows/CI/badge.svg)](https://github.com/JuliaDynamics/StateSpaceSets.jl/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/JuliaDynamics/StateSpaceSets.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaDynamics/StateSpaceSets.jl)
[![Package Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/StateSpaceSets)](https://pkgs.genieframework.com?packages=StateSpaceSets)

A Julia package that provides functionality for state space sets.
These are collections of points of fixed, and known by type, size (called dimension).
It is used in several projects in the JuliaDynamics organization,
such as [DynamicalSystems.jl](https://juliadynamics.github.io/DynamicalSystems.jl/dev/)
or [CausalityTools.jl](https://juliadynamics.github.io/CausalityTools.jl/dev/).

It is used by many other packages in the JuliaDynamics organization.
The main export of `StateSpaceSets` is the concrete type `StateSpaceSet`.
The package also provides functionality for distances, neighbor searches,
sampling, and normalization.

To install it you may run `import Pkg; Pkg.add("StateSpaceSets")`,
however, there is no real reason to install this package directly
as it is re-exported by all downstream packages that use it.

_previously StateSpaceSets.jl was part of DelayEmbeddings.jl_
as it is re-exported by all downstream packages that use it.

0 comments on commit ada46a7

Please sign in to comment.