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 Shpinx documentation #58

Closed
tcmetzger opened this issue Oct 11, 2024 · 3 comments · Fixed by #119
Closed

Update Shpinx documentation #58

tcmetzger opened this issue Oct 11, 2024 · 3 comments · Fixed by #119
Assignees
Milestone

Comments

@tcmetzger
Copy link
Collaborator

Updated documentation is available at https://pyrte-rrtmgp.readthedocs.io/, including information about the additional low-level and high-level interface features added in Phase 2. This also includes information about the conventions used in the Python frontend. The documentation also includes usage examples (based on the existing usage examples / tests in the repo as much as possible) and provides the basis for building a documentation following the Diataxis framework.

@tcmetzger tcmetzger self-assigned this Oct 11, 2024
@tcmetzger tcmetzger added this to the Phase 2 milestone Oct 11, 2024
@tcmetzger tcmetzger moved this from To Do to In progress in pyRTE Phase 2 Dec 4, 2024
@tcmetzger tcmetzger linked a pull request Feb 12, 2025 that will close this issue
@tcmetzger
Copy link
Collaborator Author

Waiting for #55 to be ready

@tcmetzger
Copy link
Collaborator Author

Updates to readme in #111

@tcmetzger tcmetzger removed a link to a pull request Mar 11, 2025
@tcmetzger tcmetzger linked a pull request Mar 11, 2025 that will close this issue
@tcmetzger
Copy link
Collaborator Author

ToDos:

  • Update user docs for new Python frontend
  • Link to (or include) example notebooks
  • Update installation instructions to reflect new conda package and dev install (with RTE-RRTMGP as conda dependency instead of local build)
  • Update contributing docs about how to make a conda release Update documentation for release (conda) #120

@tcmetzger tcmetzger changed the title Update user documentation Update Shpinx documentation Mar 12, 2025
@github-project-automation github-project-automation bot moved this from In progress to Done in pyRTE Phase 2 Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant