main.yml

name: driftscan-ci-build
on:
  pull_request:
    branches:
    - master
  push:
    branches:
    - master

jobs:

  lint-code:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Set up Python 3.12
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"

    - name: Install apt dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y libopenmpi-dev openmpi-bin libhdf5-serial-dev

    - name: Install lint requirements
      run: |
        pip install black pydocstyle

    - name: Check code with black
      run: black --check .

    # TODO: add the rest of the project to this test
    - name: Check docstrings
      run: pydocstyle --convention=numpy tests/test_simplepolarizationtelescope.py

  run-tests:

    strategy:
      matrix:
        python-version: ["3.9", "3.12"]

    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Install apt dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y libhdf5-serial-dev libopenmpi-dev openmpi-bin

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install pip dependencies
      run: |
        pip install -e .
        pip install -e .[test]
    
    - name: Run tests
      env:
        OMP_NUM_THREADS: 1
      # Because of issues with MPI forking, the two functional tests must be run within
      # separate processes or the second one won't run
      run: |
        cd tests
        pytest -s test_blockla.py test_simplepolarizationtelescope.py
        pytest -s test_functional.py
        pytest -s test_functional_skip.py

  build-docs:

    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Set up Python 3.12
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"

    - name: Install apt dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y libhdf5-serial-dev libopenmpi-dev openmpi-bin

    - name: Install pip dependencies
      run: |
        pip install -e .
        pip install -e .[docs]
    
    - name: Build sphinx docs
      run: sphinx-build -W -b html doc/ doc/_build/html