Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added description of available notebooks to README.md #15

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,12 @@ jupyter lab
```

It will open a web browser with the Jupyter Lab environment, in file-browser on left side bar open the notebook (\*.ipynb files) of interest. Select the kernel `sequgen-demo` to run the notebook.

## Available notebooks

* [test_mvp.ipynb](https://github.com/sequgen/notebooks/blob/main/test_mvp.ipynb): Introduction to sequgen. Start with this notebook if you are new to generating time series with sequgen
* [test_five_models.ipynb](https://github.com/sequgen/notebooks/blob/main/test_five_models.ipynb): Example on how different time series can be combined in sequgen.
* [gallery.ipynb](https://github.com/sequgen/notebooks/blob/main/gallery.ipynb): Overview of the available shapes of time series in sequgen.
* [hiccup.ipynb](https://github.com/sequgen/notebooks/blob/main/hiccup.ipynb): Case study: generate a time series for hiccups with sequgen
* [bird_flapping.ipynb](https://github.com/sequgen/notebooks/blob/main/bird_flapping.ipynb): Case study: recreate a time series of bird movements with sequgen
* [ggir-use-case-1.ipynb](https://github.com/sequgen/notebooks/blob/main/ggir-use-case-1.ipynb): Case study: build a time series for sleep patterns with sequgen