Merge pull request #412 from NCAR/main

v2.11.0

Author: K20shores

.github/workflows/CI_Tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
         matrix:
           os: [ubuntu-latest, macos-latest, windows-latest]
-          python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+          python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
 
     runs-on: ${{ matrix.os }}
     steps:
@@ -60,6 +60,7 @@ jobs:
         music_box -c src/acom_music_box/examples/configs/analytical/my_config.json -o output.csv
         music_box -e Analytical -o output.csv
         music_box -e Analytical -o output.csv -vv --color-output
-        waccmToMusicBox waccmDir="./sample_waccm_data" date="20240904" time="07:00" latitude=3.1 longitude=101.7
+        waccmToMusicBox --waccmDir "./sample_waccm_data" --date "20240904" --time "07:00" --latitude 3.1 --longitude 101.7
+        waccmToMusicBox --wrfchemDir "./sample_waccm_data" --date "20250820" --time "08:00" --latitude 47.0,49.0 --longitude "'-123.0,-121.0'"
 
       shell: pwsh

.github/workflows/docker_tests.yml

@@ -21,6 +21,7 @@ jobs:
         os: [ubuntu-latest]
         dockerfile:
           - Dockerfile
+          - Dockerfile.docs
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -31,7 +32,8 @@ jobs:
         run: rm -rf /opt/hostedtoolcache
 
       - name: Build Docker image
-        run: docker build -t music-box -f docker/${{ matrix.dockerfile }} . --build-arg MUSIC_BOX_GIT_TAG=${{ github.sha }} 
+        run: docker build -t music-box -f docker/${{ matrix.dockerfile }} .
 
       - name: Run tests in container
+        if: matrix.dockerfile == 'Dockerfile'
         run: docker run --name test-container -t music-box

.github/workflows/gh_pages.yml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+---
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt

.readthedocs.yaml

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 message: If you use this software, please cite it as below.
 title: MusicBox
-version: v2.10.0
+version: v2.11.0
 authors:
   - family-names: Dawson
     given-names: Matthew

CITATION.cff

@@ -189,3 +189,21 @@ pip install -e '.[dev]'
 ```
 pytest
 ```
+
+## Tool: waccmToMusicBox
+
+The python script waccmToMusicBox will extract concentrations of chemical species from WACCM and WRF-Chem, and write those values to initial conditions for MusicBox. Here are several examples of its use:
+
+```
+waccmToMusicBox --waccmDir "./sample_waccm_data" --date "20240904" --time "07:00" --latitude 3.1 --longitude 101.7
+waccmToMusicBox --wrfchemDir "./sample_waccm_data" --date "20250820" --time "08:00" --latitude 47.0,49.0 --longitude "'-123.0,-121.0'"
+
+waccmToMusicBox --waccmDir ~/MusicBox/WACCM/model-output --musicaDir ~/MusicBox/WACCM/csvJsonDir --date 20240301 --time 07:00 --latitude "'-4.0,-2.0'" --longitude 101.0,103.0 --template ~/MusicBox/WACCM/templates/TS1 --output CSV,JSON --verbose
+waccmToMusicBox --wrfchemDir ~/MusicBox/WRF-Chem/model-output --musicaDir ~/MusicBox/WRF-Chem/csvJsonDir --date 20250820 --time 08:00 --latitude 47.6 --longitude -122.325 --template ~/MusicBox/WRF-Chem/templates/TS1 --output CSV,JSON --verbose
+```
+
+Use the built-in help function to obtain a list of command-line parameters.
+```
+waccmToMusicBox --help
+```
+

README.md

@@ -1,7 +1,6 @@
 FROM fedora:latest
 
-ARG MUSIC_BOX_TAG=main
-ARG MUSICA_TAG=v0.12.2
+ARG MUSICA_TAG=v0.13.0
 
 RUN dnf -y update \
     && dnf -y install \

docker/Dockerfile

@@ -18,16 +18,9 @@ COPY . /music-box/
 
 WORKDIR /music-box
 
-
 RUN pip3 install -e .
 
-ARG SUFFIX=""
-ENV SWITCHER_SUFFIX=$SUFFIX
-
-RUN echo "The suffix is '$SWITCHER_SUFFIX'"
-
 RUN cd docs \
     && pip install -r requirements.txt \
-    && pip install --upgrade pip ipython ipykernel \
     && make html
 

docker/Dockerfile.docs

@@ -1,3 +1,5 @@
+ipython
+ipykernel
 sphinx
 sphinx-book-theme
 sphinx-copybutton