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.

Sign up for GitHub

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

Jump to bottom

[develop]: Update python docstrings and generate preliminary technical documentation #1131

Merged
merged 94 commits into from
Oct 2, 2024
Merged

[develop]: Update python docstrings and generate preliminary technical documentation #1131

merged 94 commits into from
Oct 2, 2024

Commits on Mar 14, 2023

  1. restructure docs to have UG and Tech documentation via autodoc

    @gspetro
    gspetro committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    b9ac737 View commit details
    Browse the repository at this point in the history

  2. add UG requirements file

    @gspetro
    gspetro committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    f566a27 View commit details
    Browse the repository at this point in the history

  3. update config file

    @gspetro
    gspetro committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    5b2f2df View commit details
    Browse the repository at this point in the history

  4. update config file location

    @gspetro
    gspetro committed Mar 14, 2023
    Configuration menu
    Copy the full SHA
    1feac5e View commit details
    Browse the repository at this point in the history

Commits on Mar 16, 2023

  1. minor changes

    @gspetro
    gspetro committed Mar 16, 2023
    Configuration menu
    Copy the full SHA
    25239bf View commit details
    Browse the repository at this point in the history

Commits on Mar 17, 2023

  1. add additional modules

    @gspetro
    gspetro committed Mar 17, 2023
    Configuration menu
    Copy the full SHA
    eff6b91 View commit details
    Browse the repository at this point in the history

Commits on Jul 5, 2023

  1. merge develop into autodoc

    @gspetro-NOAA
    gspetro-NOAA committed Jul 5, 2023
    Configuration menu
    Copy the full SHA
    a4a4553 View commit details
    Browse the repository at this point in the history

Commits on Jan 29, 2024

  1. merge develop branch into autodoc branch

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    8ed9658 View commit details
    Browse the repository at this point in the history

  2. update Xlink to references.bib

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    9592a9b View commit details
    Browse the repository at this point in the history

  3. update python string to HEAD of develop

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    f2cb058 View commit details
    Browse the repository at this point in the history

  4. update retrieve_data.py comments

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    e9a0214 View commit details
    Browse the repository at this point in the history

  5. update retrieve_data.py comments; del .DS_Store

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    924990e View commit details
    Browse the repository at this point in the history

  6. mv files from UG to docs

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    1ac2815 View commit details
    Browse the repository at this point in the history

  7. minor edis

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    bf298ae View commit details
    Browse the repository at this point in the history

  8. minor updates/formatting

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    a39f4aa View commit details
    Browse the repository at this point in the history

  9. update docstrings for retrieve_data.py

    @gspetro-NOAA
    gspetro-NOAA committed Jan 29, 2024
    Configuration menu
    Copy the full SHA
    3822c82 View commit details
    Browse the repository at this point in the history

Commits on Jan 30, 2024

  1. add tech docs for tests; update script docstrings

    @gspetro-NOAA
    gspetro-NOAA committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    10084ae View commit details
    Browse the repository at this point in the history

  2. add init.py to tests so that sphinx views tests as module

    @gspetro-NOAA
    gspetro-NOAA committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    07ca3d7 View commit details
    Browse the repository at this point in the history

  3. rm __init__.py; adjust sys.path & module paths

    @gspetro-NOAA
    gspetro-NOAA committed Jan 30, 2024
    Configuration menu
    Copy the full SHA
    b2767c1 View commit details
    Browse the repository at this point in the history

Commits on Feb 2, 2024

  1. add ush & tests files to index; configure to warn for undocumented fu… 

    …nctions
    @gspetro-NOAA
    gspetro-NOAA committed Feb 2, 2024
    Configuration menu
    Copy the full SHA
    14715b5 View commit details
    Browse the repository at this point in the history

Commits on Mar 1, 2024

  1. rename docs to doc

    @gspetro-NOAA
    gspetro-NOAA committed Mar 1, 2024
    Configuration menu
    Copy the full SHA
    54c61fa View commit details
    Browse the repository at this point in the history

Commits on Mar 6, 2024

  1. merge in develop

    @gspetro-NOAA
    gspetro-NOAA committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    e05e78a View commit details
    Browse the repository at this point in the history

  2. resolve merge conflicts

    @gspetro-NOAA
    gspetro-NOAA committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    af061b8 View commit details
    Browse the repository at this point in the history

  3. fix whitespace

    @gspetro-NOAA
    gspetro-NOAA committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    d5e7575 View commit details
    Browse the repository at this point in the history

  4. add autoyaml extension

    @gspetro-NOAA
    gspetro-NOAA committed Mar 6, 2024
    Configuration menu
    Copy the full SHA
    54a5669 View commit details
    Browse the repository at this point in the history

Commits on May 25, 2024

  1. merge HEAD of develop

    @gspetro-NOAA
    gspetro-NOAA committed May 25, 2024
    Configuration menu
    Copy the full SHA
    90f0bf8 View commit details
    Browse the repository at this point in the history

  2. fix broken EMC link

    @gspetro-NOAA
    gspetro-NOAA committed May 25, 2024
    Configuration menu
    Copy the full SHA
    7108c93 View commit details
    Browse the repository at this point in the history

  3. add mock imports

    @gspetro-NOAA
    gspetro-NOAA committed May 25, 2024
    Configuration menu
    Copy the full SHA
    6c944bf View commit details
    Browse the repository at this point in the history

Commits on Jun 5, 2024

  1. Merge branch 'ufs-community:develop' into text/autodoc

    @gspetro-NOAA
    gspetro-NOAA authored Jun 5, 2024
    Configuration menu
    Copy the full SHA
    01b7aac View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2024

  1. Merge branch 'ufs-community:develop' into text/autodoc

    @gspetro-NOAA
    gspetro-NOAA authored Aug 9, 2024
    Configuration menu
    Copy the full SHA
    3c3e836 View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2024

  1. update docstrings in get_crontab_contents; make private members explicit

    @gspetro-NOAA
    gspetro-NOAA committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    f49418f View commit details
    Browse the repository at this point in the history

  2. add autodoc default options

    @gspetro-NOAA
    gspetro-NOAA committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    10b56f8 View commit details
    Browse the repository at this point in the history

  3. add autoyaml to the doc README

    @gspetro-NOAA
    gspetro-NOAA committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    53819c3 View commit details
    Browse the repository at this point in the history

  4. rm duplicative INSTALL/RUNTIME files - Issue ufs-community#340

    @gspetro-NOAA
    gspetro-NOAA committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    4b7a2e5 View commit details
    Browse the repository at this point in the history

  5. update docstring for set_predef_grid_params

    @gspetro-NOAA
    gspetro-NOAA committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    cf8e0bf View commit details
    Browse the repository at this point in the history

Commits on Aug 21, 2024

  1. update conf.py autodoc defaults

    @gspetro-NOAA
    gspetro-NOAA committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    ad8835c View commit details
    Browse the repository at this point in the history

  2. rm nems configure file

    @gspetro-NOAA
    gspetro-NOAA committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    e5c0a90 View commit details
    Browse the repository at this point in the history

  3. add ufs configure file to tech docs

    @gspetro-NOAA
    gspetro-NOAA committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    a52be18 View commit details
    Browse the repository at this point in the history

Commits on Aug 22, 2024

  1. update docstrings for calculate_cost and check_python_version

    @gspetro-NOAA
    gspetro-NOAA committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    d721622 View commit details
    Browse the repository at this point in the history

  2. update docstring in config_utils.py

    @gspetro-NOAA
    gspetro-NOAA committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    404d46d View commit details
    Browse the repository at this point in the history

  3. update docstring in create_aqm_rc_file

    @gspetro-NOAA
    gspetro-NOAA committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    5cf30a4 View commit details
    Browse the repository at this point in the history

  4. update docstring in create_diag_table_file

    @gspetro-NOAA
    gspetro-NOAA committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    422391f View commit details
    Browse the repository at this point in the history

  5. update docstring for create_model_configure_file

    @gspetro-NOAA
    gspetro-NOAA committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    fcd7ac2 View commit details
    Browse the repository at this point in the history

  6. update docstring for create_ufs_configure_file

    @gspetro-NOAA
    gspetro-NOAA committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    1f9b90f View commit details
    Browse the repository at this point in the history

Commits on Aug 23, 2024

  1. update docstring in generate_FV3LAM_wflow

    @gspetro-NOAA
    gspetro-NOAA committed Aug 23, 2024
    Configuration menu
    Copy the full SHA
    7956853 View commit details
    Browse the repository at this point in the history

  2. update docstrings in get_crontab_contents

    @gspetro-NOAA
    gspetro-NOAA committed Aug 23, 2024
    Configuration menu
    Copy the full SHA
    8e8522b View commit details
    Browse the repository at this point in the history

  3. update docstrings in link_fix

    @gspetro-NOAA
    gspetro-NOAA committed Aug 23, 2024
    Configuration menu
    Copy the full SHA
    486f577 View commit details
    Browse the repository at this point in the history

  4. update docstring in mrms_pull_topofhour

    @gspetro-NOAA
    gspetro-NOAA committed Aug 23, 2024
    Configuration menu
    Copy the full SHA
    08bbaab View commit details
    Browse the repository at this point in the history

  5. (partially) update retrieve_data docstrings

    @gspetro-NOAA
    gspetro-NOAA committed Aug 23, 2024
    Configuration menu
    Copy the full SHA
    858b434 View commit details
    Browse the repository at this point in the history

Commits on Aug 24, 2024

  1. update docstrings for run_srw_tests

    @gspetro-NOAA
    gspetro-NOAA committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    24d19cc View commit details
    Browse the repository at this point in the history

  2. update docstrings for set_cycle_dates & set_fv3nml_ens_stoch_seeds

    @gspetro-NOAA
    gspetro-NOAA committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    5f9d533 View commit details
    Browse the repository at this point in the history

  3. update docstring in set_fv3nml_sfc_climo_filenames

    @gspetro-NOAA
    gspetro-NOAA committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    187467b View commit details
    Browse the repository at this point in the history

  4. update docstring in set_gridparams_ESGgrid

    @gspetro-NOAA
    gspetro-NOAA committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    b51f10b View commit details
    Browse the repository at this point in the history

  5. update set_gridparams_GFDLgrid docstrings

    @gspetro-NOAA
    gspetro-NOAA committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    113a399 View commit details
    Browse the repository at this point in the history

Commits on Aug 26, 2024

  1. Merge branch 'develop' of https://github.com/ufs-community/ufs-srweat… 

    …her-app into text/autodoc
    @gspetro-NOAA
    gspetro-NOAA committed Aug 26, 2024
    Configuration menu
    Copy the full SHA
    b10d4f1 View commit details
    Browse the repository at this point in the history

Commits on Aug 27, 2024

  1. update full ush file set

    @gspetro-NOAA
    gspetro-NOAA committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    473daa4 View commit details
    Browse the repository at this point in the history

  2. revert UFS_plot_domains changes

    @gspetro-NOAA
    gspetro-NOAA committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    775303b View commit details
    Browse the repository at this point in the history

  3. rm set_namelist & set_ozone_param

    @gspetro-NOAA
    gspetro-NOAA committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    62e9869 View commit details
    Browse the repository at this point in the history

  4. update ush RST files

    @gspetro-NOAA
    gspetro-NOAA committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    10740c4 View commit details
    Browse the repository at this point in the history

  5. update index to modules.rst

    @gspetro-NOAA
    gspetro-NOAA committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    a57c7a8 View commit details
    Browse the repository at this point in the history

Commits on Aug 28, 2024

  1. update docstrings in set_predef_grid_params and setup

    @gspetro-NOAA
    gspetro-NOAA committed Aug 28, 2024
    Configuration menu
    Copy the full SHA
    f226ded View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2024

  1. update docstrings for update_input_nml

    @gspetro-NOAA
    gspetro-NOAA committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    ee7547a View commit details
    Browse the repository at this point in the history

  2. add ush modules.rst

    @gspetro-NOAA
    gspetro-NOAA committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    e495d25 View commit details
    Browse the repository at this point in the history

  3. minor docstring updates to misc files

    @gspetro-NOAA
    gspetro-NOAA committed Aug 29, 2024
    Configuration menu
    Copy the full SHA
    7033661 View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2024

  1. minor updates to several docstrings

    @gspetro-NOAA
    gspetro-NOAA committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    2c6eb59 View commit details
    Browse the repository at this point in the history

Commits on Sep 5, 2024

  1. update misc docstrings esp in python_utils

    @gspetro-NOAA
    gspetro-NOAA committed Sep 5, 2024
    Configuration menu
    Copy the full SHA
    16b7225 View commit details
    Browse the repository at this point in the history

Commits on Sep 6, 2024

  1. update misc docstrings in python_utils

    @gspetro-NOAA
    gspetro-NOAA committed Sep 6, 2024
    Configuration menu
    Copy the full SHA
    f41c27a View commit details
    Browse the repository at this point in the history

  2. update misc python_utils docstrings

    @gspetro-NOAA
    gspetro-NOAA committed Sep 6, 2024
    Configuration menu
    Copy the full SHA
    996ca7d View commit details
    Browse the repository at this point in the history

Commits on Sep 9, 2024

  1. update misc docstrings in python_utils

    @gspetro-NOAA
    gspetro-NOAA committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    2919edc View commit details
    Browse the repository at this point in the history

Commits on Sep 10, 2024

  1. update docstrings for WE2E python files; add modules.rst

    @gspetro-NOAA
    gspetro-NOAA committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    61a3fc9 View commit details
    Browse the repository at this point in the history

  2. add index/modules.rst files

    @gspetro-NOAA
    gspetro-NOAA committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    7fc1305 View commit details
    Browse the repository at this point in the history

  3. rm old index/modules.rst versions

    @gspetro-NOAA
    gspetro-NOAA committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    1fdcebd View commit details
    Browse the repository at this point in the history

  4. update docstrings in WE2E files

    @gspetro-NOAA
    gspetro-NOAA committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    768cc2d View commit details
    Browse the repository at this point in the history

  5. update docstrings for WE2E files

    @gspetro-NOAA
    gspetro-NOAA committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    fcc5882 View commit details
    Browse the repository at this point in the history

  6. Merge branch 'ufs-community:develop' into text/autodoc

    @gspetro-NOAA
    gspetro-NOAA authored Sep 10, 2024
    Configuration menu
    Copy the full SHA
    0660b1c View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2024

  1. format create_aqm_rc_file.py w/black

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    2549f4a View commit details
    Browse the repository at this point in the history

  2. reformat docstring for ../ush/create_aqm_rc_file.py

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    581598a View commit details
    Browse the repository at this point in the history

  3. reformat docstring in create_model_configure_file.py

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    a4b6b4e View commit details
    Browse the repository at this point in the history

  4. fix line length

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    e6e0803 View commit details
    Browse the repository at this point in the history

  5. fix line length

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    3d0fd9a View commit details
    Browse the repository at this point in the history

  6. fix line length

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    5330ab7 View commit details
    Browse the repository at this point in the history

  7. fix line length

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    c037c6a View commit details
    Browse the repository at this point in the history

  8. fix excessive deletion in get_crontab_contents.py

    @gspetro-NOAA
    gspetro-NOAA committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    2a1d95a View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2024

  1. update Gaea default data location

    @gspetro-NOAA
    gspetro-NOAA committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    0f3aef6 View commit details
    Browse the repository at this point in the history

Commits on Sep 17, 2024

  1. Merge branch 'ufs-community:develop' into text/autodoc

    @gspetro-NOAA
    gspetro-NOAA authored Sep 17, 2024
    Configuration menu
    Copy the full SHA
    54877a3 View commit details
    Browse the repository at this point in the history

  2. solve issues w/UFS_plot_domains script

    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    981e83b View commit details
    Browse the repository at this point in the history

  3. update docstrings in UFS_plot_domains

    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    9ad2328 View commit details
    Browse the repository at this point in the history

  4. refactor UFS_plot_domains

    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    9112e35 View commit details
    Browse the repository at this point in the history

  5. add UFS_plot_domains docs

    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    1b93bc0 View commit details
    Browse the repository at this point in the history

  6. fix minor capitalization/typos

    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    69a66ee View commit details
    Browse the repository at this point in the history

  7. Update ush/create_diag_table_file.py 

    Co-authored-by: Michael Lueken <63728921+MichaelLueken@users.noreply.github.com>
    @gspetro-NOAA @MichaelLueken
    gspetro-NOAA and MichaelLueken authored Sep 17, 2024
    Configuration menu
    Copy the full SHA
    ce70c21 View commit details
    Browse the repository at this point in the history

  8. change .sh to .py

    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    60ddb77 View commit details
    Browse the repository at this point in the history

  9. Merge branch 'text/autodoc' of github.com:gspetro-NOAA/ufs-srweather-… 

    …app into text/autodoc
    @gspetro-NOAA
    gspetro-NOAA committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    2ba7dbf View commit details
    Browse the repository at this point in the history

Commits on Sep 26, 2024

  1. Merge branch 'ufs-community:develop' into text/autodoc

    @gspetro-NOAA
    gspetro-NOAA authored Sep 26, 2024
    Configuration menu
    Copy the full SHA
    15542b7 View commit details
    Browse the repository at this point in the history