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

Add rendered notebooks to the docs #3556

Open
timothy-nunn opened this issue Feb 21, 2025 · 0 comments
Open

Add rendered notebooks to the docs #3556

timothy-nunn opened this issue Feb 21, 2025 · 0 comments

Comments

@timothy-nunn
Copy link
Contributor

The notebooks are currently stored in our repository in a run state. I think our notebooks should not contain any non-cell data such as plots from running on one of our machines. This also means they can become out-of-sync with PROCESS (e.g. outputs and plots) until we decide to push a newly run version up.

We should render our examples in the docs similar to https://ukaea.github.io/PyVMCON/example.html
After this, we should keep only clean notebooks in our repository (its possible ruff can be used for this).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant