Skip to content

Commit

Permalink
update readme (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasKoziorek authored Oct 2, 2024
1 parent 7bed991 commit 046bae4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
[![codecov](https://codecov.io/gh/JuliaDynamics/PeriodicOrbits.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaDynamics/PeriodicOrbits.jl)
[![Package Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/PeriodicOrbits)](https://pkgs.genieframework.com?packages=PeriodicOrbits)

Interface and algorithms for finding periodic orbits (stable or unstable) in dynamical systems based on the DynamicalSystems.jl ecosystem.
Interface and algorithms for finding both stable and unstable periodic orbits of dynamical systems based on the DynamicalSystems.jl ecosystem.

To install it, run `import Pkg; Pkg.add("PeriodicOrbits")`.

All further information is provided in the documentation, which you can either find online or build locally by running the `docs/make.jl` file.

**Note**: Throughout the documentation, "Periodic Orbit" is often abbreviated as "PO" for brevity.

0 comments on commit 046bae4

Please sign in to comment.