Work on cleanups for 2.3.7 release:

- Update README, changelog, and install docs. - Fix MANIFEST.in and clean up setup.py
hpc4cmb · Jun 11, 2020 · b80815e · b80815e
1 parent 5bc615e
commit b80815e
Show file tree

Hide file tree

Showing 10 changed files with 160 additions and 144 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -9,89 +9,44 @@ on:
 
 env:
   TWINE_USERNAME: __token__
-  TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+  TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }}
 
 jobs:
-  py36:
-    name: Python 3.6 wheels on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-    env:
-      CIBW_BUILD: cp36-macosx_x86_64 cp36-manylinux_x86_64
-      CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
-      CIBW_MANYLINUX_I686_IMAGE: manylinux2014
-      CIBW_BUILD_VERBOSITY: 3
-      CIBW_ENVIRONMENT_LINUX: "TOAST_STATIC_DEPS=1 TOAST_BUILD_BLAS_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran' TOAST_BUILD_LAPACK_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran'"
-      CIBW_ENVIRONMENT_MACOS: "TOAST_STATIC_DEPS=1"
-      CIBW_BEFORE_BUILD_LINUX: ./wheels/install_deps_linux.sh
-      CIBW_BEFORE_BUILD_MACOS: ./wheels/install_deps_osx.sh
-      CIBW_BEFORE_TEST: echo "" >/dev/null
-      CIBW_TEST_COMMAND: export OMP_NUM_THREADS=2; python -c 'import toast.tests; toast.tests.run()'
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-      name: Install Python
-      with:
-        python-version: '3.7'
-    - name: Install cibuildwheel
-      run: |
-        python -m pip install twine cibuildwheel==1.4.2
-    - name: Build wheel
-      run: |
-        python -m cibuildwheel --output-dir wheelhouse
-    - name: Upload to PyPI
-      run: |
-        python -m twine upload wheelhouse/toast*.whl
-  py37:
-    name: Python 3.7 wheels on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest]
-    env:
-      CIBW_BUILD: cp37-macosx_x86_64 cp37-manylinux_x86_64
-      CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
-      CIBW_MANYLINUX_I686_IMAGE: manylinux2014
-      CIBW_BUILD_VERBOSITY: 3
-      CIBW_ENVIRONMENT_LINUX: "TOAST_STATIC_DEPS=1 TOAST_BUILD_BLAS_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran' TOAST_BUILD_LAPACK_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran'"
-      CIBW_ENVIRONMENT_MACOS: "TOAST_STATIC_DEPS=1"
-      CIBW_BEFORE_BUILD_LINUX: ./wheels/install_deps_linux.sh
-      CIBW_BEFORE_BUILD_MACOS: ./wheels/install_deps_osx.sh
-      CIBW_BEFORE_TEST: echo "" >/dev/null
-      CIBW_TEST_COMMAND: export OMP_NUM_THREADS=2; python -c 'import toast.tests; toast.tests.run()'
+  sdist:
+    name: Python source dist
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-      name: Install Python
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v2
       with:
-        python-version: '3.7'
-    - name: Install cibuildwheel
-      run: |
-        python -m pip install twine cibuildwheel==1.4.2
-    - name: Build wheel
-      run: |
-        python -m cibuildwheel --output-dir wheelhouse
+        python-version: 3.7
+    - name: Install Dependencies
+      run: pip install twine numpy
+    - name: Install Package
+      run: pip install .
+    - name: Build source package
+      run: rm -rf dist && python setup.py sdist
     - name: Upload to PyPI
       run: |
-        python -m twine upload wheelhouse/toast*.whl
-  py38:
-    name: Python 3.8 wheels on ${{ matrix.os }}
+        python -m twine upload dist/toast*.tar.gz
+  wheels:
+    name: Python wheels for ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
     env:
-      CIBW_BUILD: cp38-macosx_x86_64 cp38-manylinux_x86_64
+      CIBW_BUILD: cp36-macosx_x86_64 cp36-manylinux_x86_64 cp37-macosx_x86_64 cp37-manylinux_x86_64 cp38-macosx_x86_64 cp38-manylinux_x86_64
       CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
       CIBW_MANYLINUX_I686_IMAGE: manylinux2014
       CIBW_BUILD_VERBOSITY: 3
-      CIBW_ENVIRONMENT_LINUX: "TOAST_STATIC_DEPS=1 TOAST_BUILD_BLAS_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran' TOAST_BUILD_LAPACK_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran'"
+      CIBW_ENVIRONMENT_LINUX: "PATH=/usr/lib64/mpich-3.2/bin:${PATH} TOAST_STATIC_DEPS=1 TOAST_BUILD_BLAS_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran' TOAST_BUILD_LAPACK_LIBRARIES='-lopenblas -fopenmp -lm -lgfortran'"
       CIBW_ENVIRONMENT_MACOS: "TOAST_STATIC_DEPS=1"
       CIBW_BEFORE_BUILD_LINUX: ./wheels/install_deps_linux.sh
       CIBW_BEFORE_BUILD_MACOS: ./wheels/install_deps_osx.sh
-      CIBW_BEFORE_TEST: echo "" >/dev/null
+      CIBW_BEFORE_TEST: pip3 install numpy && pip3 install mpi4py
       CIBW_TEST_COMMAND: export OMP_NUM_THREADS=2; python -c 'import toast.tests; toast.tests.run()'
     steps:
     - uses: actions/checkout@v2

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,10 +1,14 @@
 include README.md
 include AUTHORS
 include LICENSE
-include src
 include CMakeLists.txt
-include tutorial
-include example
-include platforms
-include cmake
-include docs
+recursive-include src *
+recursive-include pipelines *
+recursive-include tutorial *
+recursive-include examples *
+prune examples/job*
+prune examples/data
+recursive-include platforms *
+recursive-include cmake *
+recursive-include docs *
+prune docs/_build
diff --git a/README.md b/README.md
@@ -1,7 +1,16 @@
 # Time Ordered Astrophysics Scalable Tools
 
-![Build Status](https://github.com/hpc4cmb/toast/workflows/Run%20Test%20Suite/badge.svg?branch=master)
+TOAST is a `software framework <https://en.wikipedia.org/wiki/Software_framework>`_ for
+simulating and processing timestream data collected by telescopes. Telescopes which
+collect data as timestreams rather than images give us a unique set of analysis
+challenges. Detector data usually contains noise which is correlated in time as well as
+sources of correlated signal from the instrument and the environment. Large pieces of
+data must often be analyzed simultaneously to extract an estimate of the sky signal.
+
+## Documentation
 
 See the full documentation here:
 
 https://toast-cmb.readthedocs.io/en/latest/
+
+![Build Status](https://github.com/hpc4cmb/toast/workflows/Run%20Test%20Suite/badge.svg?branch=master)
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -3,10 +3,43 @@
 Change Log
 -------------------------
 
-2.3.7 (Unreleased)
+2.3.8 (Unreleased)
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* Nothing yet.
+
+
+2.3.7 (2020-06-XX)
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Documentation updates and deployment of pip wheels on tags (PR `#XXX`_).
+* Fix a bug in parallel writing of Healpix FITS files (PR `#354`_).
+* Remove dependence on MPI compilers.  Only mpi4py is needed (PR `#350`_).
+* Use the native mapmaker by default in the example pipelines (PR `#352`_).
+* Updates to build system for pip wheel compatibility (PR `#348`_, `#351`_).
+* Switch to github actions instead of travis for continuous integration (PR `#349`_).
+* Updates to many parts of the simulation and filtering operators (PR `#341`_).
+* In the default Healpix pointing matrix, support None for HWP angle (PR `#345`_).
+* Add support for HWP in conviqt beam convolution (PR `#343`_).
+* Reimplementation of example jobs used for benchmarks (PR `#332`_).
+* Apply atmosphere scaling in temperature, not intensity (PR `#328`_).
+* Minor bugfix in binner when running in debug mode (PR `#325`_).
+* Add optional boresight offset to the scheduler (PR `#329`_).
+* Implement helper tools for parsing mapmaker options (PR `#321`_).
+
+.. _`#XXX`: https://github.com/hpc4cmb/toast/pull/XXX
+.. _`#354`: https://github.com/hpc4cmb/toast/pull/354
+.. _`#350`: https://github.com/hpc4cmb/toast/pull/350
+.. _`#352`: https://github.com/hpc4cmb/toast/pull/352
+.. _`#351`: https://github.com/hpc4cmb/toast/pull/351
+.. _`#349`: https://github.com/hpc4cmb/toast/pull/349
+.. _`#341`: https://github.com/hpc4cmb/toast/pull/341
+.. _`#345`: https://github.com/hpc4cmb/toast/pull/345
+.. _`#343`: https://github.com/hpc4cmb/toast/pull/343
+.. _`#332`: https://github.com/hpc4cmb/toast/pull/332
+.. _`#328`: https://github.com/hpc4cmb/toast/pull/328
+.. _`#325`: https://github.com/hpc4cmb/toast/pull/325
+.. _`#329`: https://github.com/hpc4cmb/toast/pull/329
+.. _`#321`: https://github.com/hpc4cmb/toast/pull/321
 
 2.3.6 (2020-01-19)
 ~~~~~~~~~~~~~~~~~~~~~~~~~