[infra] refine README narrative and accuracy #761
This file contains hidden or 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: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| # -- Tests ----------------------------------------------------------------- | |
| test-core: | |
| name: Tests (Python ${{ matrix.python-version }}) | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: pip install -e ".[dev]" | |
| - name: Run tests | |
| run: python -m pytest tests/ -v -m "not fenics and not slow" | |
| # -- Paper compilation ----------------------------------------------------- | |
| compile-papers: | |
| name: "Compile ${{ matrix.paper.name }}" | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| paper: | |
| - { name: "Paper 1 - Brown Note", dir: "papers/paper1-brown-note", artifact: "paper-1-browntone" } | |
| - { name: "Paper 2 - Gas Pockets", dir: "papers/paper2-gas-pockets", artifact: "paper-2-gas-pockets" } | |
| - { name: "Paper 3 - Scaling Laws", dir: "papers/paper3-scaling-laws", artifact: "paper-3-scaling-laws" } | |
| - { name: "Paper 4 - Bladder Resonance", dir: "papers/paper4-bladder", artifact: "paper-4-bladder" } | |
| - { name: "Paper 5 - Borborygmi", dir: "papers/paper5-borborygmi", artifact: "paper-5-borborygmi" } | |
| - { name: "Paper 6 - Sub-Bass", dir: "papers/paper6-sub-bass", artifact: "paper-6-sub-bass" } | |
| - { name: "Paper 7 - Watermelon", dir: "papers/paper7-watermelon", artifact: "paper-7-watermelon" } | |
| - { name: "Paper 8 - Kac", dir: "papers/paper8-kac", artifact: "paper-8-kac" } | |
| - { name: "Paper 9 - Identifiability Asymmetry", dir: "papers/paper9-lifting-theorem", artifact: "paper-9-lifting-theorem" } | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Compile LaTeX | |
| uses: xu-cheng/latex-action@v3 | |
| with: | |
| root_file: main.tex | |
| working_directory: ${{ matrix.paper.dir }} | |
| - name: Upload PDF | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.paper.artifact }} | |
| path: ${{ matrix.paper.dir }}/main.pdf | |
| retention-days: 30 | |
| # -- Consistency checks (PRs only) ---------------------------------------- | |
| consistency-check: | |
| name: Consistency Check | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'pull_request' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install package | |
| run: pip install -e ".[dev]" | |
| - name: Run consistency checks | |
| run: python scripts/check_consistency.py | |
| # -- Figure generation (push to main only) --------------------------------- | |
| generate-figures: | |
| name: Generate Figures | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'push' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install dependencies | |
| run: pip install -e ".[dev]" | |
| - name: Generate figures | |
| env: | |
| MPLBACKEND: Agg | |
| run: python scripts/generate_all_figures.py | |
| - name: Upload figures | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: generated-figures | |
| path: papers/paper1-brown-note/figures/*.pdf | |
| retention-days: 30 |