Use int minval instead -1 for invalid telescope ids in SubarrayDescription.tel_index_array, improve docstrings #3727
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: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - "**" | |
| pull_request: | |
| env: | |
| NUMBA_NUM_THREADS: 1 | |
| MPLBACKEND: Agg | |
| PYTEST_ADDOPTS: --color=yes | |
| GITHUB_PR_NUMBER: ${{ github.event.number }} | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| - uses: pre-commit/action@v3.0.0 | |
| with: | |
| extra_args: --files $(git diff origin/main --name-only) | |
| tests: | |
| runs-on: ${{ matrix.os }} | |
| needs: lint | |
| strategy: | |
| matrix: | |
| include: | |
| - os: ubuntu-latest | |
| python-version: "3.9" | |
| install-method: mamba | |
| - os: ubuntu-latest | |
| python-version: "3.10" | |
| install-method: mamba | |
| extra-args: ["codecov"] | |
| - os: ubuntu-latest | |
| python-version: "3.11" | |
| install-method: mamba | |
| - os: ubuntu-latest | |
| python-version: "3.11" | |
| install-method: pip | |
| - os: macos-latest | |
| python-version: "3.11" | |
| install-method: mamba | |
| - os: macos-latest | |
| python-version: "3.9" | |
| install-method: pip | |
| defaults: | |
| run: | |
| # We need login shells (-l) for micromamba to work. | |
| shell: bash -leo pipefail {0} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: cache test data | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/ctapipe | |
| key: ctapipe-test-data | |
| - name: Prepare mamba installation | |
| if: matrix.install-method == 'mamba' | |
| env: | |
| PYTHON_VERSION: ${{ matrix.python-version }} | |
| run: | | |
| # setup correct python version | |
| sed -i -e "s/- python=.*/- python=$PYTHON_VERSION/g" environment.yml | |
| - name: mamba setup | |
| if: matrix.install-method == 'mamba' | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: environment.yml | |
| cache-downloads: true | |
| - name: Python setup | |
| if: matrix.install-method == 'pip' | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| check-latest: true | |
| - if: ${{ matrix.install-method == 'pip' && runner.os == 'macOS' }} | |
| name: Fix Python PATH on macOS | |
| # See https://github.com/actions/setup-python/issues/132 and | |
| # https://github.com/actions/setup-python/issues/132#issuecomment-779406058 | |
| # Login shells on macOS prepend system paths, so we need to | |
| # prepend the python path from actions/setup-python. | |
| # Micromamba sets up ~/.bash_profile, where we need to set the path now. | |
| run: | | |
| tee -a ~/.bash_profile <<<'export PATH="$pythonLocation/bin:$PATH"' | |
| - name: Install dependencies | |
| run: | | |
| python --version | |
| pip install pytest-cov restructuredtext-lint pytest-xdist 'coverage!=6.3.0' | |
| pip install .[all] | |
| pip install ./test_plugin | |
| pip freeze | |
| - name: Static codechecks | |
| run: | | |
| restructuredtext-lint README.rst | |
| - name: ctapipe-info | |
| run: | | |
| ctapipe-info --all | |
| - name: Tests | |
| run: | | |
| cd $(mktemp -d) | |
| pytest -n auto --dist loadscope \ | |
| --cov --cov-report=xml \ | |
| --doctest-modules --doctest-glob='*.rst' \ | |
| --ignore=$HOME/work/ctapipe/ctapipe/docs/conf.py \ | |
| --pyargs ctapipe $HOME/work/ctapipe/ctapipe/docs | |
| ctapipe-info --version | |
| - uses: codecov/codecov-action@v3 | |
| if: contains(matrix.extra-args, 'codecov') | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.9" | |
| - name: Install doc dependencies | |
| run: | | |
| sudo apt update --yes && sudo apt install --yes git build-essential pandoc graphviz ffmpeg | |
| pip install -U pip towncrier | |
| pip install -e .[docs] | |
| pip install ./test_plugin | |
| git describe --tags | |
| python -c 'import ctapipe; print(ctapipe.__version__)' | |
| - name: Produce Changelog | |
| run: | | |
| towncrier build --yes | |
| - name: Build docs | |
| run: make doc | |
| - name: Deploy to github pages | |
| # only run on push to master | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} | |
| uses: JamesIves/github-pages-deploy-action@3.7.1 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages | |
| FOLDER: docs/_build/html | |
| CLEAN: true | |
| SINGLE_COMMIT: true | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: docs | |
| path: docs/_build/html |