Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rusandris authored Jul 17, 2024
1 parent 94b4ce6 commit 52bbe43
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# StateTransitionNetworks.jl
Toolkit for dynamics on state-transition networks based on the paper Sándor et al. (2022).


## Installation
Download a local copy, go to the directory and use the package in REPL:
Download and install automatically to your local/global `julia` environment with:
```julia
pkg> activate .
] add https://github.com/rusandris/StateTransitionNetworks.jl.git
using StateTransitionNetworks
```
Or download and install automatically to your local/global `julia` environment with:

Or download a local copy, go to the directory and use the package in REPL:
```julia
pkg> add https://github.com/rusandris/StateTransitionNetworks.jl.git
] activate .
using StateTransitionNetworks
```

<!---
## Basic usage
### Discrete example: Henon map
Expand Down Expand Up @@ -127,7 +128,7 @@ There is a higher level function that accepts a time series and returns the corr
stn_analysis(timeseries::Matrix;grid,plane,idxs,ensemble=100,N_steps=1000,make_ergodic=false, verbose=false,return_stn=false,use_analytic=false,use_stored_distribution=false)
```

-->


# References
Expand Down

0 comments on commit 52bbe43

Please sign in to comment.