Skip to content

Commit

Permalink
Added simple documentation with mkdocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
DuncDennis committed Mar 12, 2023
1 parent 7dc8077 commit 4c8d7e5
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/lorenzpy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""Python package to simulate and Measure chaotic time series."""
"""Python package to simulate and Measure chaotic time series.
Modules exported by this package:
- `simulations`: Simulate various discrete and continuous chaotic dynamical systems.
- `measures`: Measures for the chaotic dynamical systems.
"""

from . import measures, simulations

Expand Down

0 comments on commit 4c8d7e5

Please sign in to comment.