Skip to content

Commit

Permalink
Merge branch 'ufs-community:develop' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
gspetro-NOAA authored Oct 30, 2024
2 parents 6a483d1 + 563dd40 commit 80e9ad3
Show file tree
Hide file tree
Showing 101 changed files with 2,026 additions and 1,071 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ ush/python_utils/__pycache__/
ush/python_utils/workflow-tools/
ush/*.swp
conda_loc
*/.DS_Store

*.swp
__pycache__
4 changes: 0 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,4 @@ python:
install:
- requirements: doc/requirements.txt

submodules:
include:
- hpc-stack-mod
recursive: true

2 changes: 1 addition & 1 deletion doc/ContribGuide/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Fork and PR Overview

Contributions to the ``ufs-srweather-app`` project are made via a :github-docs:`Fork<pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks>` and :github-docs:`Pull Request (PR)<pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>` model. GitHub provides a thorough description of this contribution model in their `Contributing to a project` :github-docs:`Quickstart<get-started/exploring-projects-on-github/contributing-to-a-project>`, but the steps, with respect to ``ufs-srweather-app`` contributions, can be summarized as:

#. :github-docs:`Create an issue <issues/tracking-your-work-with-issues/creating-an-issue>` to document proposed changes.
#. :github-docs:`Create an issue <issues/tracking-your-work-with-issues/using-issues/creating-an-issue>` to document proposed changes.
#. :github-docs:`Fork<get-started/exploring-projects-on-github/contributing-to-a-project#forking-a-repository>` the :srw-repo:`ufs-srweather-app repository<>` into your personal GitHub account.
#. :github-docs:`Clone<get-started/exploring-projects-on-github/contributing-to-a-project>` your fork onto your development system.
#. :github-docs:`Create a branch<get-started/exploring-projects-on-github/contributing-to-a-project#creating-a-branch-to-work-on>` in your clone for your changes. All development should take place on a branch, *not* on ``develop``.
Expand Down
61 changes: 0 additions & 61 deletions doc/INSTALL

This file was deleted.

1 change: 1 addition & 0 deletions doc/README
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Steps to build and use the Sphinx documentation tool:
pip install sphinx
pip install sphinxcontrib-bibtex
pip install sphinx-rtd-theme
pip install sphinxcontrib.autoyaml

One approach that has worked to resolve "Module Not Found" errors for users with MacPorts package manager:
$ sudo port install py-six # may not be necessary
Expand Down
22 changes: 0 additions & 22 deletions doc/RUNTIME

This file was deleted.

8 changes: 8 additions & 0 deletions doc/TechDocs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Technical Documentation
===========================

.. toctree::
:maxdepth: 3

tests/index
ush/modules
7 changes: 7 additions & 0 deletions doc/TechDocs/tests/WE2E/WE2E_summary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
WE2E\_summary module
====================

.. automodule:: WE2E_summary
:members:
:undoc-members:
:show-inheritance:
11 changes: 11 additions & 0 deletions doc/TechDocs/tests/WE2E/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
WE2E
====

.. toctree::
:maxdepth: 4

WE2E_summary
monitor_jobs
print_test_info
run_WE2E_tests
utils
7 changes: 7 additions & 0 deletions doc/TechDocs/tests/WE2E/monitor_jobs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
monitor\_jobs module
====================

.. automodule:: monitor_jobs
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/tests/WE2E/print_test_info.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
print\_test\_info module
========================

.. automodule:: print_test_info
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/tests/WE2E/run_WE2E_tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
run\_WE2E\_tests module
=======================

.. automodule:: run_WE2E_tests
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/tests/WE2E/utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
utils module
============

.. automodule:: utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/tests/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
tests
======

.. toctree::
:maxdepth: 3

WE2E/modules
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/UFS_plot_domains.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
UFS\_plot\_domains module
=========================

.. automodule:: UFS_plot_domains
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/calculate_cost.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
calculate\_cost module
======================

.. automodule:: calculate_cost
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/check_python_version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
check\_python\_version module
=============================

.. automodule:: check_python_version
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/config_utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
config\_utils module
====================

.. automodule:: config_utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/create_aqm_rc_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
create\_aqm\_rc\_file module
============================

.. automodule:: create_aqm_rc_file
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/create_diag_table_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
create\_diag\_table\_file module
================================

.. automodule:: create_diag_table_file
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/create_model_configure_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
create\_model\_configure\_file module
=====================================

.. automodule:: create_model_configure_file
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/create_ufs_configure_file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
create\_ufs\_configure\_file module
===================================

.. automodule:: create_ufs_configure_file
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/generate_FV3LAM_wflow.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
generate\_FV3LAM\_wflow module
==============================

.. automodule:: generate_FV3LAM_wflow
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/get_crontab_contents.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
get\_crontab\_contents module
=============================

.. automodule:: get_crontab_contents
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/link_fix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
link\_fix module
================

.. automodule:: link_fix
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions doc/TechDocs/ush/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
ush
===

.. toctree::
:maxdepth: 4

UFS_plot_domains
calculate_cost
check_python_version
config_utils
create_aqm_rc_file
create_diag_table_file
create_model_configure_file
create_ufs_configure_file
generate_FV3LAM_wflow
get_crontab_contents
link_fix
mrms_pull_topofhour
python_utils
retrieve_data
run_srw_tests
set_cycle_dates
set_fv3nml_ens_stoch_seeds
set_fv3nml_sfc_climo_filenames
set_gridparams_ESGgrid
set_gridparams_GFDLgrid
set_predef_grid_params
setup
update_input_nml
7 changes: 7 additions & 0 deletions doc/TechDocs/ush/mrms_pull_topofhour.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
mrms\_pull\_topofhour module
============================

.. automodule:: mrms_pull_topofhour
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit 80e9ad3

Please sign in to comment.