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

Update docs pertaining to notebook #47

Open
aradhakrishnanGFDL opened this issue Aug 26, 2024 · 4 comments
Open

Update docs pertaining to notebook #47

aradhakrishnanGFDL opened this issue Aug 26, 2024 · 4 comments
Assignees

Comments

@aradhakrishnanGFDL
Copy link
Collaborator

Update sphinx docs regarding the Jupyter notebook usage to reflect the following. This is high-priority as it is needed for the tutorial video.

https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/catalogbuilder/scripts/gen_intake_gfdl_runner_config.py

@Ciheim
Copy link
Contributor

Ciheim commented Aug 26, 2024

Do you want me to update the notebook itself? The doc only contains a screenshot of the code there.

@aradhakrishnanGFDL
Copy link
Collaborator Author

Do you want me to update the notebook itself? The doc only contains a screenshot of the code there.

There is just one section that points to calling it from main here. That needs to be removed. Otherwise, looks like I had updated sections above this

https://noaa-gfdl.github.io/CatalogBuilder/generation.html#from-jupyter-notebook

@Ciheim
Copy link
Contributor

Ciheim commented Aug 26, 2024

Unless there's a more updated notebook, then https://github.com/aradhakrishnanGFDL/CatalogBuilder/blob/main/scripts/gen_intake_gfdl_notebook.ipynb itself needs to be first updated.

Otherwise, I can delete the whole screenshot and replace it with the code you linked here if we like that solution instead.

@aradhakrishnanGFDL
Copy link
Collaborator Author

Don't refer to the fork.

1- Update the notebook reference to what's in the repo

https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/catalogbuilder/scripts/gen_intake_gfdl_runner_config.py

2- git remove https://github.com/NOAA-GFDL/CatalogBuilder/blob/main/catalogbuilder/scripts/gen_intake_gfdl_notebook.ipynb

3- Also delete the section below from the docs :

from scripts import gen_intake_gfdl
import sys, os
######USER input begins########
#User provides the input directory for which a data catalog needs to be generated.
#Note that depending on the date and version of the tool, only time-series data are catalogued.
input_path = "/archive/am5/am5/am5f3b1r0/c96L65_am5f3b1r0_pdclim1850F/gfdl.ncrc5-deploy-prod-openmp/pp/"
#USER inputs the output path. Based on the following setting, user can expect to see /home/alr/mycatalog.csv and
output_path = "/home/alr/mycatalog"
####ENDOFuser1nput######批#基#
sys.argv = ['--INPUT_PATH', input_path, output_path]
try:
gen_intake_gfdl.main()
except SystemExit as e:
if e.code != 0:
raise

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

2 participants