Merge pull request #60 from fmalatino/packaging

Packaging: Use of `pyproject.toml` and move to PEP 8 naming convention for modernization

Author: fmalatino

.github/workflows/pace_tests.yaml

@@ -1,10 +1,11 @@
-name: "pace main tests"
-on:
-  pull_request:
+# TODO: Re-activate after PR 60
+# name: "pace main tests"
+# on:
+#   pull_request:
 
-jobs:
-  pace_main_tests:
-    uses: NOAA-GFDL/pace/.github/workflows/main_unit_tests.yaml@develop
-    with:
-      component_trigger: true
-      component_name: pyFV3
+# jobs:
+#   pace_main_tests:
+#     uses: NOAA-GFDL/pace/.github/workflows/main_unit_tests.yaml@develop
+#     with:
+#       component_trigger: true
+#       component_name: pyFV3

.github/workflows/pyshield_tests.yaml

@@ -1,10 +1,11 @@
-name: "pySHiELD translate tests"
-on:
-  pull_request:
+# TODO: Reactivate after PR 60
+# name: "pySHiELD translate tests"
+# on:
+#   pull_request:
 
-jobs:
-  pyshield_translate_tests:
-    uses:  NOAA-GFDL/PySHiELD/.github/workflows/translate.yaml@develop
-    with:
-      component_trigger: true
-      component_name: pyFV3
+# jobs:
+#   pyshield_translate_tests:
+#     uses:  NOAA-GFDL/PySHiELD/.github/workflows/translate.yaml@develop
+#     with:
+#       component_trigger: true
+#       component_name: pyFV3

.github/workflows/scripts/convert_xppm_yppm.sh

@@ -10,11 +10,11 @@
 set -e
 
 # Copy XPPM codes into YPPM files
-cp pyFV3/stencils/xppm.py pyFV3/stencils/yppm.py
-cp pyFV3/stencils/xtp_u.py pyFV3/stencils/ytp_v.py
+cp pyfv3/stencils/xppm.py pyfv3/stencils/yppm.py
+cp pyfv3/stencils/xtp_u.py pyfv3/stencils/ytp_v.py
 
 # Fixup YPPM code
-for fname in pyFV3/stencils/yppm.py pyFV3/stencils/ytp_v.py
+for fname in pyfv3/stencils/yppm.py pyfv3/stencils/ytp_v.py
 do
     sed -i 's/ub/vb/g' $fname
     sed -i 's/dx/dy/g' $fname
@@ -47,18 +47,18 @@ do
     sed -i 's/\[j_end + 2, :/\[:, j_end + 2/g' $fname
 done
 
-sed -i 's/i_start/j_start/g' pyFV3/stencils/yppm.py
-sed -i 's/i_end/j_end/g' pyFV3/stencils/yppm.py
-sed -i 's/XPiecewise/YPiecewise/g' pyFV3/stencils/yppm.py
-sed -i 's/X Piecewise/Y Piecewise/g' pyFV3/stencils/yppm.py
-sed -i 's/xppm/yppm/g' pyFV3/stencils/yppm.py
-sed -i 's/u\*/v\*/g' pyFV3/stencils/yppm.py
+sed -i 's/i_start/j_start/g' pyfv3/stencils/yppm.py
+sed -i 's/i_end/j_end/g' pyfv3/stencils/yppm.py
+sed -i 's/XPiecewise/YPiecewise/g' pyfv3/stencils/yppm.py
+sed -i 's/X Piecewise/Y Piecewise/g' pyfv3/stencils/yppm.py
+sed -i 's/xppm/yppm/g' pyfv3/stencils/yppm.py
+sed -i 's/u\*/v\*/g' pyfv3/stencils/yppm.py
 
-sed -i 's/j_start - 1 : j_start + 1, j_start/i_start, j_start - 1 : j_start + 1/g' pyFV3/stencils/ytp_v.py
-sed -i 's/j_start - 1 : j_start + 1, j_end + 1/i_end + 1, j_start - 1 : j_start + 1/g' pyFV3/stencils/ytp_v.py
-sed -i 's/j_end : j_end + 2, j_start/i_start, j_end : j_end + 2/g' pyFV3/stencils/ytp_v.py
-sed -i 's/j_end : j_end + 2, j_end + 1/i_end + 1, j_end : j_end + 2/g' pyFV3/stencils/ytp_v.py
-sed -i 's/j_end, j_start, jord, j_end, j_start/i_end, i_start, j_end, j_start, jord/g' pyFV3/stencils/ytp_v.py
-sed -i 's/xppm/yppm/g' pyFV3/stencils/ytp_v.py
+sed -i 's/j_start - 1 : j_start + 1, j_start/i_start, j_start - 1 : j_start + 1/g' pyfv3/stencils/ytp_v.py
+sed -i 's/j_start - 1 : j_start + 1, j_end + 1/i_end + 1, j_start - 1 : j_start + 1/g' pyfv3/stencils/ytp_v.py
+sed -i 's/j_end : j_end + 2, j_start/i_start, j_end : j_end + 2/g' pyfv3/stencils/ytp_v.py
+sed -i 's/j_end : j_end + 2, j_end + 1/i_end + 1, j_end : j_end + 2/g' pyfv3/stencils/ytp_v.py
+sed -i 's/j_end, j_start, jord, j_end, j_start/i_end, i_start, j_end, j_start, jord/g' pyfv3/stencils/ytp_v.py
+sed -i 's/xppm/yppm/g' pyfv3/stencils/ytp_v.py
 
-sed -i 's/region\[j_start - 1 : j_start + 2, :\], region\[j_end - 1 : j_end + 2, :\]/region\[:, j_start - 1 : j_start + 2\], region\[:, j_end - 1 : j_end + 2\]/g' pyFV3/stencils/yppm.py
+sed -i 's/region\[j_start - 1 : j_start + 2, :\], region\[j_end - 1 : j_end + 2, :\]/region\[:, j_start - 1 : j_start + 2\], region\[:, j_end - 1 : j_end + 2\]/g' pyfv3/stencils/yppm.py

Dockerfile

@@ -29,10 +29,10 @@ RUN which python
 RUN pip --version
 RUN which pip
 
-COPY ./ /pyFV3/
+COPY . /pyfv3
 
 # Install pyFV3 and the full dependencies
-RUN pip install -e pyFV3[develop]
+RUN cd /pyfv3 && pip install -e .[develop]
 
 RUN pip install \
     matplotlib \

examples/standalone/runfile/acoustics.py

@@ -21,9 +21,9 @@
 )
 from ndsl.performance import Timer
 from ndsl.stencils.testing import Grid
-from pyFV3 import DynamicalCoreConfig
-from pyFV3.stencils import AcousticDynamics
-from pyFV3.testing import TranslateDynCore
+from pyfv3 import DynamicalCoreConfig
+from pyfv3.stencils import AcousticDynamics
+from pyfv3.testing import TranslateDynCore
 
 
 try:

examples/standalone/runfile/compile.py

@@ -9,7 +9,7 @@
 import gt4py.cartesian.config
 
 from ndsl import NullComm
-from pyFV3 import DynamicalCoreConfig
+from pyfv3 import DynamicalCoreConfig
 
 
 try:

examples/standalone/runfile/dynamics.py

@@ -30,9 +30,9 @@
 from ndsl.grid import DampingCoefficients, GridData, MetricTerms
 from ndsl.performance import Timer
 from ndsl.stencils.testing import Grid, dataset_to_dict
-from pyFV3 import DycoreState, DynamicalCore, DynamicalCoreConfig
-from pyFV3.initialization.test_cases import init_baroclinic_state
-from pyFV3.testing import TranslateFVDynamics
+from pyfv3 import DycoreState, DynamicalCore, DynamicalCoreConfig
+from pyfv3.initialization.test_cases import init_baroclinic_state
+from pyfv3.testing import TranslateFVDynamics
 
 
 def parse_args() -> Namespace: