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

👌 Use notebooks for the examples #26

Open
2 of 3 tasks
s-weigand opened this issue Jun 15, 2021 · 1 comment
Open
2 of 3 tasks

👌 Use notebooks for the examples #26

s-weigand opened this issue Jun 15, 2021 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@s-weigand
Copy link
Member

s-weigand commented Jun 15, 2021

Using notebooks for the examples would allow us to:

  • Have a rich text documentation of the case studies themself (e.g. explanation text and references to papers)
  • Use read the docs to host a rendered version with plots

In order to achieve this, some extra tooling will be needed:

  • [ ] Script to quickly convert notebooks to *.py files for debugging
  • Distributed pre-evaluation of notebooks on the CI, so read the docs doesn't need to run them all at once (risk of timeout)
  • Rewriting of the gh-action to use pytest + nbval papermill
  • Compatibility of setup_case_study with notebooks since ipython doesn't define __file__
@s-weigand s-weigand added the enhancement New feature or request label Jun 15, 2021
@s-weigand s-weigand self-assigned this Jun 15, 2021
@jsnel
Copy link
Member

jsnel commented Jun 9, 2024

In PR #103 the examples were ported to notebooks.

@jsnel jsnel changed the title 👌 Use notebook for the examples 👌 Use notebooks for the examples Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants