Merge pull request #125 from nanograv/cbd_abdot

Merging Cbd abdot branch to dev. This branch uses an entirely different evolution class: `cEvolution.`

Author: pranav-satheesh

.github/publish_to_pypi.yaml

@@ -0,0 +1,43 @@
+name: Build and publish Python distributions to PyPI
+on:
+  push:
+    # !! TEMPORARILY DISABLE THIS WORKFLOW / ACTION !!
+    branches-ignore:
+      - '**'
+    # branches:
+    #   - "main"
+
+jobs:
+  build-publish:
+    name: Build and publish Python distributions to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - name: git checkout repository main
+      uses: actions/checkout@v3
+
+    - name: check github reference for tags
+      run: |
+        echo "github.ref = ${{ github.ref }}, github.ref_type = ${{ github.ref_type }}"
+        echo "github.repository = ${{ github.repository }}, github.event_name = ${{ github.event_name }} "
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+
+    - name: Install pypa/build
+      run: python -m pip install build --user
+
+    - name: Build a binary wheel and a source tarball
+      run: python -m build --sdist --wheel --outdir dist/ .
+
+    # - name: Publish distribution to Test PyPI
+    #   uses: pypa/gh-action-pypi-publish@master
+    #   with:
+    #     password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+    #     repository_url: https://test.pypi.org/legacy/
+
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -70,6 +70,10 @@ target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+notebooks/*.pkl
+# notebooks for CBD tutorials, will be modified and included after merge with dev
+notebooks/cbd/*.ipynb
+notebooks/cbd/*.py
 
 # pyenv
 .python-version

.readthedocs.yml

@@ -10,6 +10,10 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
   jobs:
     post_install:
       - python setup.py build_ext -i
@@ -18,6 +22,7 @@ build:
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: docs/source/conf.py
+   # fail_on_warning: true
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 formats:
@@ -27,3 +32,6 @@ python:
    install:
    - requirements: docs/requirements.txt
    - requirements: requirements.txt
+
+# conda:
+#   environment: docs/requirements.yaml