From 1df3752b3f3d5bd6d79dbd0e6ed34724d3597d31 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 9 May 2024 15:40:41 -0600 Subject: [PATCH 1/3] using a literal include for python requirements --- docs/Contributors_Guide/index.rst | 27 +-------------------------- 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/docs/Contributors_Guide/index.rst b/docs/Contributors_Guide/index.rst index a65abcfb..90facfcb 100644 --- a/docs/Contributors_Guide/index.rst +++ b/docs/Contributors_Guide/index.rst @@ -9,32 +9,7 @@ other scripts. Python Requirements =================== -* Python 3.10.4 - -* imutils 0.5.4 - -* imageio 2.25.0 - -* metpy 1.4.0 - -* netcdf4 1.6.2 - -* numpy 1.24.1 - -* opencv-python 4.7.0.68 - -* pandas 1.4.2 - -* pytest 7.1.2 - -* pyyaml 6.0 - -* scikit-image 0.19.3 - -* scipy 1.10.0 - -* xarray 2023.1.0 - +.. literalinclude:: ../../requirements.txt Coding Standards ================ From 3136c8572d090d98905c1c25755a62a85e9a50a8 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 9 May 2024 15:48:44 -0600 Subject: [PATCH 2/3] adding extra sentence --- docs/Contributors_Guide/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Contributors_Guide/index.rst b/docs/Contributors_Guide/index.rst index 90facfcb..9130d8fb 100644 --- a/docs/Contributors_Guide/index.rst +++ b/docs/Contributors_Guide/index.rst @@ -9,6 +9,8 @@ other scripts. Python Requirements =================== +The requirements below come directly from the **requirements.txt** file at the top level of the repository. + .. literalinclude:: ../../requirements.txt Coding Standards From a8f3ba6a6864739db54656c89b1812a3035f5cd2 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 13 May 2024 10:06:15 -0600 Subject: [PATCH 3/3] Per #379, modified the Python requirements section (and modified some additional links) --- docs/Contributors_Guide/index.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/Contributors_Guide/index.rst b/docs/Contributors_Guide/index.rst index 9130d8fb..de7f3d2c 100644 --- a/docs/Contributors_Guide/index.rst +++ b/docs/Contributors_Guide/index.rst @@ -9,16 +9,14 @@ other scripts. Python Requirements =================== -The requirements below come directly from the **requirements.txt** file at the top level of the repository. - -.. literalinclude:: ../../requirements.txt +For information about the Python Requirements for METcalcpy, please see the User’s Guide `Python Requirements `_ section in the `Installation Guide `_. Coding Standards ================ -METplus has adopted some coding standards for its Python code. Detailed information can be found here: https://metplus.readthedocs.io/en/latest/Contributors_Guide/coding_standards.html +METplus has adopted some coding standards for its Python code. Detailed information can be found in the `METplus Coding Standards `_ documentation. -Comment the Python code using Python docstrings: https://peps.python.org/pep-0257/ +Comment the Python code using `Python docstring conventions `_. Organization of Code in the Github Repository =============================================