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

[develop] Add AQM to SRW user's guide #846

Merged
merged 10 commits into from
Jun 28, 2023

Conversation

chan-hoo
Copy link
Collaborator

DESCRIPTION OF CHANGES:

  • Add documentation for Air Quality Modeling (AQM) to the user's guide.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

TESTS CONDUCTED:

  • This is an update only for doc.
  • hera.intel
  • orion.intel
  • cheyenne.intel
  • cheyenne.gnu
  • gaea.intel
  • jet.intel
  • wcoss2.intel
  • NOAA Cloud (indicate which platform)
  • Jenkins
  • fundamental test suite
  • comprehensive tests (specify which if a subset was used)

ISSUE:

Fixes issue mentioned in #625

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain).
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • Any dependent changes have been merged and published

LABELS:

  • Work In Progress
  • bug
  • enhancement
  • documentation
  • release
  • high priority
  • run_ci
  • run_we2e_fundamental_tests
  • run_we2e_comprehensive_tests
  • Needs Cheyenne test
  • Needs Jet test
  • Needs Hera test
  • Needs Orion test
  • help wanted

CONTRIBUTORS:

@chan-hoo
Copy link
Collaborator Author

@gspetro-NOAA, could you let me know how I can test this change in the doc?

Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chan-hoo I was able to use readthedocs to build the updated User's Guide in your branch:

https://mikes-ufs-srweather-app-fork.readthedocs.io/en/feature-aqm_doc/AQM.html

In my review, I've noted dead links to a table that has been removed as part of this PR, minor spelling issues (code-clock rather than code-block keeping the build method from appearing in the documentation), and adding a ` to the end of the table and figure declarations.

Additionally, we have a new entry in the Code Contributor's Guide about not allowing binary files into be merged to the authoritative repository. You might want to reach out to @gspetro-NOAA for additional information on how to stage the file on the SRW App's wiki and then point to it in the AQM.rst file.

docs/UsersGuide/source/AQM.rst Show resolved Hide resolved
docs/UsersGuide/source/AQM.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/AQM.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/AQM.rst Outdated Show resolved Hide resolved
docs/UsersGuide/source/AQM.rst Outdated Show resolved Hide resolved
@chan-hoo
Copy link
Collaborator Author

@MichaelLueken, thanks for the fix. I've updated it. @gspetro-NOAA, regarding @MichaelLueken's comment about a binary file, could you let me know how to resolve this issue?

Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chan-hoo Table 7.2 still isn't appearing in the users guide. Adding a line between lines 238 and 239 allows the table to be generated and adds the table link on line 234.

docs/UsersGuide/source/AQM.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chan-hoo One last update with respect to changing regional_workflow to workflow_tools, line 54 is still using regional_workflow, so it would be best to replace this as well.

Once this has been completed, I think that the only issue will be dealing with the binary file and ensuring that it shows up in the User's Guide.

docs/UsersGuide/source/AQM.rst Show resolved Hide resolved
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chan-hoo There has been issues with the image appearing in rtd. I was able to correct this issue by aligning line 173 with line 172. Once this has been complete, I'll be ready to approve this PR. Thank you very much for working with @gspetro-NOAA and myself to get everything ready for this update to the documentation!

docs/UsersGuide/source/AQM.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chan-hoo Thanks for making the requested modifications! Everything is now appearing correctly in the rtd. Approving now.

@MichaelLueken MichaelLueken merged commit b3e5e0f into ufs-community:develop Jun 28, 2023
3 checks passed
@chan-hoo chan-hoo deleted the feature/aqm_doc branch July 1, 2023 10:30
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need documentation for air quality modeling (Online-CMAQ)
3 participants