.gitlab-ci.yml

@@ -3,7 +3,7 @@ stages:
   - test
   - gen_cache
   - update_cache
-  - deploy_prep
+  - docs
   - deploy
 
 # build the docker image we will use in all the jobs, with all
@@ -43,52 +43,58 @@ test:
       - gwinc_test_report.pdf
     expose_as: 'GWINC test failure report PDF'
 
-# prep for doc generation
-clean_docs:
-  stage: deploy_prep
-  needs:
-    - test
-  script:
-    - rm -rf public
-    - mkdir public
-  artifacts:
-    when: always
-    paths:
-      - public
-
 # create plots for the canonical IFOs
-ifos:
-  stage: deploy
+ifo:
+  stage: docs
   needs:
-    - clean_docs
+    - test
   image: $CI_REGISTRY_IMAGE/images/base:$CI_COMMIT_REF_NAME
   script:
-      - mkdir -p public/ifo
+      - mkdir -p ifo
       - export PYTHONPATH=/inspiral_range
       - for ifo in $(python3 -c "import gwinc; print(' '.join(gwinc.IFOS))"); do
-      -     python3 -m gwinc $ifo -s public/ifo/$ifo.png
-      -     python3 -m gwinc $ifo -s public/ifo/$ifo.h5
+      -     python3 -m gwinc $ifo -s ifo/$ifo.png
+      -     python3 -m gwinc $ifo -s ifo/$ifo.h5
       - done
-      - python3 -m gwinc.ifo -s public/ifo/all_compare.png
+      - python3 -m gwinc.ifo -s ifo/all_compare.png
   artifacts:
     when: always
     paths:
-      - public/ifo
+      - ifo
 
 # generate the html doc web pages
-pages:
-  stage: deploy
+html:
+  stage: docs
   only:
     - master
   needs:
-    - clean_docs
+    - test
   image: $CI_REGISTRY_IMAGE/images/base:$CI_COMMIT_REF_NAME
   script:
+    - rm -rf public
     - apt-get install -y -qq python3-sphinx-rtd-theme
     - cd docs
     - make html
     - cd ..
-    - mv ./build/sphinx/html/* public/
+    - mv ./build/sphinx/html public
+  artifacts:
+    when: always
+    paths:
+      - public
+
+pages:
+  stage: deploy
+  only:
+    - master
+  needs:
+    - job: ifo
+      artifacts: true
+    - job: html
+      artifacts: true
+  image: $CI_REGISTRY_IMAGE/images/base:$CI_COMMIT_REF_NAME
+  script:
+    - mv ifo public/
   artifacts:
+    when: always
     paths:
       - public

IFO.md

@@ -2,43 +2,43 @@
 
 CI-generated plots and data for all IFOs included in pygwinc.
 
-![IFO compare](https://gwinc.docs.ligo.org/pygwinc/all_compare.png)
+![IFO compare](https://gwinc.docs.ligo.org/pygwinc/ifo/all_compare.png)
 
 ## aLIGO
 
 * [ifo.yaml](gwinc/ifo/aLIGO/ifo.yaml)
-* [aLIGO.h5](https://gwinc.docs.ligo.org/pygwinc/aLIGO.h5)
+* [aLIGO.h5](https://gwinc.docs.ligo.org/pygwinc/ifo/aLIGO.h5)
 
-![aLIGO](https://gwinc.docs.ligo.org/pygwinc/aLIGO.png)
+![aLIGO](https://gwinc.docs.ligo.org/pygwinc/ifo/aLIGO.png)
 
 
 ## A+
 
 * [ifo.yaml](gwinc/ifo/Aplus/ifo.yaml)
-* [Aplus.h5](https://gwinc.docs.ligo.org/pygwinc/Aplus.h5)
+* [Aplus.h5](https://gwinc.docs.ligo.org/pygwinc/ifo/Aplus.h5)
 
-![Aplus](https://gwinc.docs.ligo.org/pygwinc/Aplus.png)
+![Aplus](https://gwinc.docs.ligo.org/pygwinc/ifo/Aplus.png)
 
 
 ## Voyager
 
 * [ifo.yaml](gwinc/ifo/Voyager/ifo.yaml)
-* [Voyager.h5](https://gwinc.docs.ligo.org/pygwinc/Voyager.h5)
+* [Voyager.h5](https://gwinc.docs.ligo.org/pygwinc/ifo/Voyager.h5)
 
-![Voyager](https://gwinc.docs.ligo.org/pygwinc/Voyager.png)
+![Voyager](https://gwinc.docs.ligo.org/pygwinc/ifo/Voyager.png)
 
 
 ## Cosmic Explorer 1
 
 * [ifo.yaml](gwinc/ifo/CE1/ifo.yaml)
-* [CE1.h5](https://gwinc.docs.ligo.org/pygwinc/CE1.h5)
+* [CE1.h5](https://gwinc.docs.ligo.org/pygwinc/ifo/CE1.h5)
 
-![CE1](https://gwinc.docs.ligo.org/pygwinc/CE1.png)
+![CE1](https://gwinc.docs.ligo.org/pygwinc/ifo/CE1.png)
 
 
 ## Cosmic Explorer 2
 
 * [ifo.yaml](gwinc/ifo/CE2/ifo.yaml)
-* [CE2.h5](https://gwinc.docs.ligo.org/pygwinc/CE2.h5)
+* [CE2.h5](https://gwinc.docs.ligo.org/pygwinc/ifo/CE2.h5)
 
-![CE2](https://gwinc.docs.ligo.org/pygwinc/CE2.png)
+![CE2](https://gwinc.docs.ligo.org/pygwinc/ifo/CE2.png)

README.md

@@ -2,12 +2,14 @@
 
 # Python Gravitational Wave Interferometer Noise Calculator
 
-![gwinc](https://gwinc.docs.ligo.org/pygwinc/aLIGO.png)
+[![aLIGO](https://gwinc.docs.ligo.org/pygwinc/ifo/aLIGO.png "Canonical
+IFOs")](IFO.md)
 
 `pygwinc` is a multi-faceted tool for processing and plotting noise
 budgets for ground-based gravitational wave detectors.  It's primary
-feature is a collection of mostly analytic noise calculation functions
-for various sources of noise affecting detectors (`gwinc.noise`):
+feature is a collection of mostly analytic [noise calculation
+functions](#noise-functions) for various sources of noise affecting
+detectors (`gwinc.noise`):
 
 * quantum noise
 * mirror coating thermal noise
@@ -17,22 +19,20 @@ for various sources of noise affecting detectors (`gwinc.noise`):
 * Newtonian/gravity-gradient noise
 * residual gas noise
 
-See [noise functions](#noise-functions) below.
-
-`pygwinc` also includes a generalized noise budgeting tool
-(`gwinc.nb`) that allows users to create arbitrary noise budgets (for
-any experiment, not just ground-based GW detectors) using measured or
-analytically calculated data.  See the [budget
-interface](#Budget-interface) section below.
+`pygwinc` is also a generalized noise budgeting tool (`gwinc.nb`) that
+allows users to create arbitrary noise budgets (for any experiment,
+not just ground-based GW detectors) using measured or analytically
+calculated data.  See the [budget interface](#Budget-interface)
+section below.
 
 `pygwinc` includes canonical budgets for various well-known current
-and future detectors (`gwinc.ifo`):
+and future GW detectors (`gwinc.ifo`):
 
-* [aLIGO](https://gwinc.docs.ligo.org/pygwinc/aLIGO.png)
-* [A+](https://gwinc.docs.ligo.org/pygwinc/Aplus.png)
-* [Voyager](https://gwinc.docs.ligo.org/pygwinc/Voyager.png)
-* [Cosmic Explorer 1](https://gwinc.docs.ligo.org/pygwinc/CE1.png)
-* [Cosmic Explorer 2](https://gwinc.docs.ligo.org/pygwinc/CE2.png)
+* [aLIGO](https://gwinc.docs.ligo.org/pygwinc/ifo/aLIGO.png)
+* [A+](https://gwinc.docs.ligo.org/pygwinc/ifo/Aplus.png)
+* [Voyager](https://gwinc.docs.ligo.org/pygwinc/ifo/Voyager.png)
+* [Cosmic Explorer 1](https://gwinc.docs.ligo.org/pygwinc/ifo/CE1.png)
+* [Cosmic Explorer 2](https://gwinc.docs.ligo.org/pygwinc/ifo/CE2.png)
 
 See [IFO.md](IFO.md) for the latest CI-generated plots and hdf5 cached
 data.
@@ -325,13 +325,7 @@ traces = budget.run()
 ```
 
 The IFOs included in `gwinc.ifo` provide examples of the use of the
-budget interface:
-
-* [aLIGO](gwinc/ifo/aLIGO)
-* [Aplus](gwinc/ifo/Aplus)
-* [Voyager](gwinc/ifo/Voyager)
-* [CE1](master/gwinc/ifo/CE1)
-* [CE2](master/gwinc/ifo/CE2)
+budget interface (e.g. [gwinc.ifo.aLIGO](gwinc/ifo/aLIGO)).
 
 
 ### extracting single noise terms