https://github.com/dynamicslab/pysindy-example

Template for example notebooks to include in pysindy's docs
https://github.com/dynamicslab/pysindy-example

Last synced: 14 days ago
JSON representation

Template for example notebooks to include in pysindy's docs

• Host: GitHub
• URL: https://github.com/dynamicslab/pysindy-example
• Owner: dynamicslab
• License: mit
• Created: 2024-09-28T03:40:12.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T03:55:18.000Z (3 months ago)
• Last Synced: 2024-11-12T03:18:03.815Z (2 months ago)
• Size: 2.68 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pysindy-example

Template for example notebooks to include in pysindy's docs.  The purpose of this is to move the onus for documentation and dependency  management of pysindy's more exotic examples to their authors.  Over time, most of pysindy's current documentation will move to this format.

To make a new example, follow the instructions on pysindy's README.  Adding an

example begins here:

1. Clone this repository, changing the project name and description in docs/conf.py

1. Save the notebooks in `examples`

1. Edit the toctree in examples/index.rst, adding each experiment notebook

1. Add notebook run dependencies to examples/requirements.txt

1. Build the documentation and verify it builds without warning or error:

```

pip install -r requirements-docs.txt

sphinx-build -W docs/source docs/build

```

1. Add and commit build result

Other dependency methods, e.g. pyproject.toml, are acceptable.  You will need

to modify the appropriate CI step

There are two CI files: one to build the documentation, one to run the experiments

against new versions of pysindy.  If you do not plan on updating the example code,

its fine to leave the example dependent upon an old version of pysindy: delete the

pysindy.yml CI file.

Finally, you must tell pysindy about your example.  This occurs in two places:

1. pysindy documentation configuration needs to know to add your documents.

1. If you want to try to maintain your example across breaking pysindy changes,

add your repository to the CI notification list.