Skip to content

Initial pyFV3 documentation generated by MkDocs#67

Closed
gmao-ckung wants to merge 65 commits intoNOAA-GFDL:developfrom
gmao-ckung:feature/documentation
Closed

Initial pyFV3 documentation generated by MkDocs#67
gmao-ckung wants to merge 65 commits intoNOAA-GFDL:developfrom
gmao-ckung:feature/documentation

Conversation

@gmao-ckung
Copy link
Collaborator

Description
This branch contains pyFV3 documentation that is generated by MkDocs and based on the docstrings within the pyFV3 source files.

@gmao-ckung gmao-ckung marked this pull request as ready for review July 15, 2025 15:31
@gmao-ckung
Copy link
Collaborator Author

gmao-ckung commented Jul 15, 2025

Note : The stencil section can be merged into a single markdown file. However, I note that the table of contents for the stencil section will only (at least from what I've tried) display functions from the a2b_ord4.py file. Having separate markdown files for each python stencil file will enable the table of contents to be unique to each stencil class.

@FlorianDeconinck
Copy link
Collaborator

Move the new files in a docs folder alongside tests

FlorianDeconinck and others added 21 commits July 15, 2025 16:42
- Fully move from AI2 to NOAA-GDFL
- Restrict python version to 3.11
- Consistent license information
- Pin NDSL at latest release (2024.09.00)
This was added a while back (at AI2) when - for a brief amount of time -
the idea as to ship some translate test data with the package. This idea
was rejected and now the configuration option isn't needed anymore.
Fix F32 pure python computation for beta, gamma
Update not implemented with more strict message
Remove extraneous subset slicing in translate test
Copy the orchestration call from yppm back to xppm to synchronize the
two.
Path to stencils changed when importing files into this repo. Adapted
that path.

I also changed `gsed` to `sed` because on (nonBSD) linux systems, the
default `sed` flavor is gnu `sed`.
Linting should give fast feedback. The current wokflow took almost 3
minutes where most time is spent installing (unnecessary) python
packages. To run `pre-commit` we only need the source files and
`pre-commit`, which can be installed standalone. This brings the runtime
down to ~30 seconds.

Other changes:
 - update checkout action to v4
 - update python setup action to v5
 - change python version from 3.11.7 to 3.11 (any patch number will do)
Add a step to the linting workflow that ensures consistency in the
XPPM/YPPM codes.
Currently, translate tests go and fetch test_data/ from scratch every
run. Every now and then, the server isn't available. This PR caches
test_data/ as part of the translate test workflow.
jjuyeonkim and others added 28 commits July 16, 2025 10:40
With PR NOAA-GFDL/NDSL#104 that function was
deprecated in favor of `get_precision()`. The new fuction is a drop-in
replacement for the old one.
Don't set `PACE_TEST_N_THRESHOLD_SAMPLES` in translate tests anymore
since the environment variable was renamed in PR
NOAA-GFDL/NDSL#134 and the default changed to
match the currently configured behavior.
Newer GT4Py versions ship with a vendored in version of the boost header
file that it needs. And since NDSL updated its GT4Py version, we don't
need to install boost anymore in the `Dockerfile` for PyFV3. Not sure if
anyone uses the docker version, but it's easy enough to just clean up.
refactored remaining imports to comply with new ndsl import method
…n in `pyproject.toml` (NOAA-GFDL#68)

* Use new-style license information to avoid warning
* update linting tools
@gmao-ckung gmao-ckung closed this Jul 16, 2025
@gmao-ckung gmao-ckung deleted the feature/documentation branch July 16, 2025 15:12
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

Successfully merging this pull request may close these issues.

6 participants