Skip to content

Commit

Permalink
Add doc section and link to notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
Ceyron committed Apr 10, 2024
1 parent 2d470a4 commit b92ca03
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<a href="#installation">Installation</a> •
<a href="#quickstart">Quickstart</a> •
<a href="#features">Features</a> •
<a href="#documentation">Documentation</a> •
<a href="#background">Background</a> •
<a href="#related">Related</a> •
<a href="#license">License</a>
Expand Down Expand Up @@ -58,6 +59,8 @@ plt.xlabel("Time"); plt.ylabel("Space"); plt.show()

![](img/ks_rollout.png)

For a next step, check out the [simple_advection_example_1d.ipynb](examples/simple_advection_example_1d.ipynb) notebook in the `examples` folder, and check out the <a href="#documentation">Documentation</a>.

## Features


Expand Down Expand Up @@ -88,6 +91,15 @@ plt.xlabel("Time"); plt.ylabel("Space"); plt.show()
7. Normalized interface for reduced number of parameters to uniquely define any
dynamics.

## Documentation

The following Jupyter notebooks showcase the usage of the package:

1. [Simple Advection Example in 1d](examples/simple_advection_example_1d.ipynb)
2. ...

The documentation is still in progress. For now, the best way to get started is
to look at the examples and the docstrings in the code.

## Background

Expand Down

0 comments on commit b92ca03

Please sign in to comment.