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

Enhance reanalysis-forced notebook #96

Open
navidcy opened this issue Feb 16, 2024 · 5 comments
Open

Enhance reanalysis-forced notebook #96

navidcy opened this issue Feb 16, 2024 · 5 comments
Labels
documentation 📔 Improvements or additions to documentation joss 📓

Comments

@navidcy
Copy link
Contributor

navidcy commented Feb 16, 2024

Let's enhance the notebook reanalysis-forced at https://regional-mom6.readthedocs.io/en/latest/demo_notebooks/reanalysis-forced.html with some plots of, e.g, the domain or the initial condition etc.

Also let's add a thumbnail to appear at https://regional-mom6.readthedocs.io/en/latest/demos.html

@navidcy navidcy added the documentation 📔 Improvements or additions to documentation label Feb 16, 2024
@navidcy navidcy changed the title Enhance Enhance reanalysis-forced notebook Feb 16, 2024
@angus-g
Copy link
Collaborator

angus-g commented Feb 22, 2024

Maybe moving discussion from #99 here: I've implemented a way to run the notebooks in the container on GitHub (where the model, tools, and input data are available), and provide that notebook to RTD. Example build is https://regional-mom6.readthedocs.io/en/angus-g-render-notebooks/demo_notebooks/reanalysis-forced.html, from the angus-g/render-notebooks branch.

At the moment, there's both the GitHub push webhook, and the RTDS action webhook firing for the same version, so it's not perfectly integrated until we completely switch over. There might be a little bit more to do in generating previews for PRs (for this demo, I had to manually activate the branch on RTD).

@navidcy
Copy link
Contributor Author

navidcy commented Feb 22, 2024

This looks great!

@navidcy navidcy mentioned this issue Apr 2, 2024
@aekiss
Copy link
Contributor

aekiss commented Apr 22, 2024

Also let's add a thumbnail to appear at https://regional-mom6.readthedocs.io/en/latest/demos.html

thumbnail still missing

@angus-g
Copy link
Collaborator

angus-g commented Apr 22, 2024

Probably need to push a version of that notebook with a plot somewhere for it to show up, or specify a thumbnail file...

@navidcy
Copy link
Contributor Author

navidcy commented Apr 22, 2024

Yes. Related to this issue is #119 which if resolved then we could have the notebook cells evaluated locally and push.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation joss 📓
Projects
None yet
Development

No branches or pull requests

3 participants