Tests using physical simulations #398
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Tests for PROTEUS | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - ready_for_review | |
| workflow_dispatch: | |
| jobs: | |
| test: | |
| if: github.event.pull_request.draft == false | |
| name: Run Coverage and Tests | |
| strategy: | |
| matrix: | |
| os: ['ubuntu-latest', 'macos-latest'] | |
| python-version: ['3.11', '3.13'] | |
| include: | |
| - os: ubuntu-latest | |
| INSTALL_DEPS: sudo apt-get install libnetcdff-dev netcdf-bin | |
| CC: gcc | |
| CXX: g++ | |
| FC: gfortran | |
| - os: macos-latest | |
| INSTALL_DEPS: brew install gfortran netcdf netcdf-fortran | |
| CC: gcc | |
| CXX: g++ | |
| FC: gfortran | |
| env: | |
| FWL_DATA: $HOME/work/fwl_data | |
| RAD_DIR: ./SOCRATES | |
| SOCRATES: ./SOCRATES # https://github.com/FormingWorlds/JANUS/issues/51 | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| # https://stackoverflow.com/a/65356209 | |
| - name: Install system dependencies | |
| run: ${{ matrix.INSTALL_DEPS }} | |
| # Checkout PROTEUS | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: 'false' | |
| # Setup Python using the version defined in the matrix | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| # Try to restore the Python environment from the cache | |
| - uses: actions/cache@v4 | |
| id: cache-virtualenv | |
| with: | |
| path: ${{ env.pythonLocation }} | |
| key: ${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }} | |
| # Setup Aragog | |
| - name: Get Aragog interior model | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: 'ExPlanetology/aragog' | |
| path: 'aragog' | |
| - name: Install Aragog | |
| run: | | |
| python -m pip install -e aragog/. | |
| - name: Install Python dependencies | |
| # if: steps.cache-virtualenv.outputs.cache-hit != 'true' | |
| run: | | |
| python -m pip install -e .[develop] | |
| # Get lookup data for PROTEUS | |
| - name: Get FWL data from cache | |
| uses: actions/cache@v4 | |
| id: cache-fwl-data | |
| with: | |
| path: ${{ env.FWL_DATA }} | |
| key: fwl-data-2 | |
| - name: Get additional FWL data | |
| if: steps.cache-fwl-data.cache-hit != 'true' | |
| run: | | |
| proteus get stellar | |
| proteus get spectral --name Frostflow --bands 48 | |
| # Setup SOCRATES - copied from JANUS | |
| - name: Get SOCRATES radiative tranfer model | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: 'nichollsh/SOCRATES' | |
| path: 'SOCRATES' | |
| # Try to restore SOCRATES from the cache | |
| - uses: actions/cache@v4 | |
| id: cache-socrates | |
| with: | |
| path: | | |
| SOCRATES/bin | |
| SOCRATES/sbin | |
| SOCRATES/set_rad_env | |
| key: socrates-${{ hashFiles('SOCRATES/version') }} | |
| # Build SOCRATES if we can't restore it from the cache | |
| - name: Build SOCRATES | |
| if: steps.cache-socrates.outputs.cache-hit != 'true' | |
| run: | | |
| export LD_LIBRARY_PATH="" | |
| cd SOCRATES | |
| ./configure | |
| ./build_code | |
| cd .. | |
| # Run PROTEUS tests | |
| - name: Test with pytest | |
| run: | | |
| coverage run -m pytest | |
| # Upload output run images if tests fail | |
| - name: Upload PNG plots as artifacts | |
| if: failure() | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: png-plots | |
| path: | | |
| output/physical/plot_atmosphere.png | |
| output/physical/plot_escape.png | |
| output/physical/plot_global_log.png | |
| output/physical/plot_observables.png | |
| output/physical/plot_stacked.png | |
| output/physical/plot_elements.png | |
| output/physical/plot_fluxes_atmosphere.png | |
| output/physical/plot_interior_cmesh.png | |
| output/physical/plot_sflux_cross.png | |
| output/physical/plot_emission.png | |
| output/physical/plot_interior.png | |
| output/physical/plot_sflux.png | |
| - name: Report coverage | |
| run: | | |
| coverage json | |
| export TOTAL=$(python -c "import json;print(json.load(open('coverage.json'))['totals']['percent_covered_display'])") | |
| echo "total=$TOTAL" >> $GITHUB_ENV | |
| echo "### Total coverage: ${TOTAL}%" >> $GITHUB_STEP_SUMMARY | |
| echo $'\n```' >> $GITHUB_STEP_SUMMARY | |
| coverage report >> $GITHUB_STEP_SUMMARY | |
| echo $'\n```' >> $GITHUB_STEP_SUMMARY | |
| - name: Make coverage badge | |
| if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.10' }} | |
| uses: schneegans/dynamic-badges-action@v1.7.0 | |
| with: | |
| auth: ${{ secrets.GIST_TOKEN }} | |
| gistID: b4ee7dab92e20644bcb3a5ad09f71165 | |
| filename: covbadge.svg | |
| label: Coverage | |
| message: ${{ env.total }}% | |
| minColorRange: 50 | |
| maxColorRange: 90 | |
| valColorRange: ${{ env.total }} |