From e15dba338916a4df337b6f4e3597ffd030fe0d09 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 12 Nov 2024 13:01:50 -0700 Subject: [PATCH] Per #2300, add Python package disclaimer for the METplus components --- docs/Contributors_Guide/coding_standards.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/Contributors_Guide/coding_standards.rst b/docs/Contributors_Guide/coding_standards.rst index 67cee26da1..bfc099be76 100644 --- a/docs/Contributors_Guide/coding_standards.rst +++ b/docs/Contributors_Guide/coding_standards.rst @@ -4,6 +4,9 @@ Coding Standards **************** +Guidelines +========== + * Python code style outlined in `PEP8 `_ * `Doxygen `_, `Python docstrings `_, and @@ -11,3 +14,20 @@ Coding Standards * **NOTE: Please do not use f-strings in the run_metplus.py file so that the Python version check can notify the user of the incorrect version. Using Python 3.5 or earlier will output the SyntaxError from the f-string instead of the useful error message.** Python code analysis tools like **pylint** can be used to check for errors and violations of PEP8 standards. + +Python Package Disclaimer +========================= + +Any external Python packages used in the METplus components are defined in the +requirements.txt file and, if applicable, nco_requirements.txt file in the top +level of the code repositories. It is important that the METplus components only +require Python packages that are allowed on operational high performance +computers (HPCs). The process of approval for some HPCs can take months and +some packages have been denied. + +Proceed with caution and request approval before starting development with a +new Python package. Some general guidelines to consider when choosing new +potential Python packages are: + + * The package would ideally have a version number of 1 or greater. + * Ensure that the package is regularly being maintained.