.gitlab-ci.yml

# This script is an edited version of the example found at
# https://git.ligo.org/lscsoft/example-ci-project/blob/python/.gitlab-ci.yml
# Each 0th-indendation level is a job that will be run within GitLab CI
# The only exception are a short list of reserved keywords
#
# https://docs.gitlab.com/ee/ci/yaml/#gitlab-ci-yml

# stages is a reserved keyword that defines job dependencies and
# parallelization. each stage runs in parallel but must complete
# before the next stage begins
# This file was copied from bilby_pipe

stages:
  - initial
  - test
  - documentation
  - deploy

.basic-python: &basic-python
  stage: initial
  image: python
  before_script:
    - pip install --upgrade pip
  script:
    - pip install --ignore-installed .
    - cd ..
    - python -c "import pygwb"
    - python -c "import pygwb.baseline"
    - python -c "import pygwb.constants"
    - python -c "import pygwb.delta_sigma_cut"
    - python -c "import pygwb.detector"
    - python -c "import pygwb.network"
    - python -c "import pygwb.notch"
    - python -c "import pygwb.orfs"
    - python -c "import pygwb.parameters"
    - python -c "import pygwb.pe"
    - python -c "import pygwb.postprocessing"
    - python -c "import pygwb.preprocessing"
    - python -c "import pygwb.simulator"
    - python -c "import pygwb.spectral"
    - python -c "import pygwb.statistical_checks"
    - python -c "import pygwb.util"
    - for script in $(pip show -f pygwb | grep "bin\/" | xargs -I {} basename {}); do
          ${script} --help;
      done

.basic-python-38: &basic-python-38
  stage: initial
  image: python
  before_script:
    - pip install --upgrade pip
  script:
    - pip install --ignore-installed .
    - pip install gwsumm==2.0.1 # have to fix these to continue using py38 due to backwards-incompatible changes in gwsumm/gwpy; should deprecate py38 soon.
    - pip install lscsoft-glue==3.0.1
    - cd ..
    - python -c "import pygwb"
    - python -c "import pygwb.baseline"
    - python -c "import pygwb.constants"
    - python -c "import pygwb.delta_sigma_cut"
    - python -c "import pygwb.detector"
    - python -c "import pygwb.network"
    - python -c "import pygwb.notch"
    - python -c "import pygwb.orfs"
    - python -c "import pygwb.parameters"
    - python -c "import pygwb.pe"
    - python -c "import pygwb.postprocessing"
    - python -c "import pygwb.preprocessing"
    - python -c "import pygwb.simulator"
    - python -c "import pygwb.spectral"
    - python -c "import pygwb.statistical_checks"
    - python -c "import pygwb.util"
    - for script in $(pip show -f pygwb | grep "bin\/" | xargs -I {} basename {}); do
          ${script} --help;
      done

basic-3.8:
  <<: *basic-python-38
  image: python:3.8

basic-3.9:
  <<: *basic-python
  image: python:3.9

basic-3.10:
  <<: *basic-python
  image: python:3.10


.precommits-python: &precommits-python
  stage: initial
  image: python
  script:
    - pip install --upgrade pip
    - pip install .
    - pip install pre-commit

    # Run precommits (black, flake8, spellcheck, isort, no merge conflicts, etc)
    - pre-commit run --files pygwb/*.py --verbose --show-diff-on-failure
    - pre-commit run --files pygwb_pipe/*.py --verbose --show-diff-on-failure
    - pre-commit run --files test/*.py --verbose --show-diff-on-failure
    - pre-commit run --files tutorials/*.py --verbose --show-diff-on-failure
    - pre-commit run --files *.py --verbose --show-diff-on-failure

precommits-py3.8:
  <<: *precommits-python
  image: python:3.8


.test-python: &test-python
  stage: test
  image: python
  before_script:
    - pip install --upgrade pip setuptools
    - pip install pytest pytest-cov coverage-badge
  script:
    - pip install .
    - pytest --cov=pygwb --cov-config=.coveragerc

python-3.8:
  <<: *test-python
  image: python:3.8
  after_script:
    - coverage html
    - coverage xml
  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
  artifacts:
    reports:
      coverage_report:
        coverage_format: cobertura
        path: coverage.xml
    paths:
      - htmlcov/
    expire_in: 30 days

python-3.9:
  <<: *test-python
  image: python:3.9

python-3.10:
  <<: *test-python
  image: python:3.10

workflow:
  stage: test
  image: python:3.10
  before_script:
    - pip install --upgrade pip setuptools
  script:
    - pip install .
    - mkdir workflow_result
    - pygwb_create_isotropic_workflow --configfile ./test/test_data/config_workflow_test.ini --basedir ./workflow_result/ --run_locally

documentation:
  stage: documentation
  image: python:3.8
  before_script:
    - apt-get -yqq update
    - apt-get -yqq install pandoc
    - pip install --upgrade pip setuptools
    - pip install ipykernel ipython==8.12.0 jupyter
    - pip install sphinx numpydoc nbsphinx sphinx_rtd_theme sphinx-tabs autodoc ipython-genutils
    - pip install .

  script:
    - cd docs
    - cp ../tutorials/*.ipynb ./
    - cp ../tutorials/*.dat ./
    - cp -r ../tutorials/input ./
    - make clean
    - make html
    - cd -

  artifacts:
    paths:
      - docs/_build

pages:
  stage: deploy
  dependencies:
    - python-3.8
    - documentation
  script:
    - mkdir public/
    - mv htmlcov/ public/
    - mv docs/_build/html/* public/
  artifacts:
    paths:
      - public
    expire_in: 30 days
  only:
  - master