Py311

.github/CODEOWNERS

@@ -0,0 +1,8 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# these owners will be requested for
+# review when someone opens a pull request.
+*       @ceb8 @scfleming

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: ".github/workflows" # Location of package manifests
+    schedule:
+      interval: "monthly"
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/workflows/black.yml

@@ -0,0 +1,10 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable

.github/workflows/ci_workflows.yml

@@ -4,8 +4,11 @@ on:
   push:
     branches:
     - main
+    - py311
     tags:
   pull_request:
+    branches:
+    - main
 
 jobs:
   tests:
@@ -16,47 +19,106 @@ jobs:
       matrix:
         include:
 
-          - name: Python 3.8.13 with minimal dependencies
-            os: ubuntu-latest
-            python: 3.8.13
-            toxenv: py38-test
+          - name: Python 3.9.xx with minimal dependencies 
+            os: ubuntu-latest 
+            python: 3.9.21 
+            toxenv: py39-test 
+
+          - name: Python 3.9.xx with all optional dependencies 
+            os: ubuntu-latest 
+            python: 3.9.21 
+            toxenv: py39-test-alldeps 
+            toxargs: -v --develop 
+            toxposargs: -W error::ResourceWarning 
+
+          - name: Python 3.9.xx with numpy 1.24 and full coverage 
+            os: ubuntu-latest 
+            python: 3.9.21
+            toxenv: py39-test-alldeps-numpy124-cov 
 
-          - name: Python 3.8.13 with all optional dependencies
+          - name: Python 3.10.xx with minimal dependencies 
             os: ubuntu-latest
-            python: 3.8.13
-            toxenv: py38-test-alldeps
-            toxargs: -v --develop
-            toxposargs: --open-files
-
-#          - name: Python 3.9.0 with all optional dependencies (Windows)
-#            os: windows-latest
-#            python: 3.9.0
-#            toxenv: py38-test-alldeps
-
-#          - name: Python 3.8.13 with all optional dependencies (MacOS X)
-#            os: macos-latest
-#            python: 3.8.13
-#            toxenv: py38-test-alldeps
+            python: 3.10.16
+            toxenv: py310-test
+
+          - name: Python 3.10.xx with all optional dependencies 
+            os: ubuntu-latest 
+            python: 3.10.16
+            toxenv: py310-test-alldeps 
+            toxargs: -v --develop 
+            toxposargs: -W error::ResourceWarning 
+
+          - name: Python 3.10.xx with numpy 1.24 and full coverage 
+            os: ubuntu-latest 
+            python: 3.10.16
+            toxenv: py310-test-alldeps-numpy124-cov 
+
+          - name: Python 3.10.xx with numpy 2.10 and full coverage 
+            os: ubuntu-latest 
+            python: 3.10.16
+            toxenv: py310-test-alldeps-numpy210-cov 
+
+          - name: Python 3.11.xx with minimal dependencies 
+            os: ubuntu-latest 
+            python: 3.11.11 
+            toxenv: py311-test 
+
+          - name: Python 3.11.xx with all optional dependencies 
+            os: ubuntu-latest 
+            python: 3.11.11 
+            toxenv: py311-test-alldeps 
+            toxargs: -v --develop 
+            toxposargs: -W error::ResourceWarning 
+
+          - name: Python 3.11.xx with numpy 1.24 and full coverage 
+            os: ubuntu-latest 
+            python: 3.11.11 
+            toxenv: py311-test-alldeps-numpy124-cov 
+
+          - name: Python 3.11.xx with numpy 2.10 and full coverage 
+            os: ubuntu-latest 
+            python: 3.11.11 
+            toxenv: py311-test-alldeps-numpy210-cov 
+
+          - name: Python 3.12.xx with minimal dependencies 
+            os: ubuntu-latest 
+            python: 3.12.8
+            toxenv: py312-test 
+
+          - name: Python 3.12.xx with all optional dependencies 
+            os: ubuntu-latest 
+            python: 3.12.8
+            toxenv: py312-test-alldeps 
+            toxargs: -v --develop 
+            toxposargs: -W error::ResourceWarning 
+
+          - name: Python 3.12.xx with numpy 2.10 and full coverage 
+            os: ubuntu-latest 
+            python: 3.12.8
+            toxenv: py312-test-alldeps-numpy210-cov 
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938  # v4.2.0
       with:
         fetch-depth: 0
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
       with:
         python-version: ${{ matrix.python }}
     - name: Install language-pack-de and tzdata
       if: startsWith(matrix.os, 'ubuntu')
       run: sudo apt-get install language-pack-de tzdata
+    - name: Install pyo dependencies
+      if: startsWith(matrix.os, 'ubuntu')
+      run: sudo apt-get install portaudio19-dev libsndfile1-dev libportmidi-dev liblo-dev
     - name: Install Python dependencies
       run: python -m pip install --upgrade tox codecov sphinx_rtd_theme
     - name: Run tests
       run: tox ${{ matrix.toxargs }} -e ${{ matrix.toxenv }} -- ${{ matrix.toxposargs }}
     - name: Upload coverage to codecov
       if: ${{ contains(matrix.toxenv,'-cov') }}
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673  # v4.5.0
       with:
         file: ./coverage.xml
 
@@ -68,23 +130,26 @@ jobs:
       matrix:
         include:
 
-          - name: Code style checks
+          - name: (Allowed Failure) Python 3.11 with dev version of key dependencies
             os: ubuntu-latest
-            python: 3.x
-            toxenv: codestyle
+            python: 3.11
+            toxenv: py311-test-devdeps
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938  # v4.2.0
       with:
         fetch-depth: 0
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
       with:
         python-version: ${{ matrix.python }}
     - name: Install language-pack-de and tzdata
       if: startsWith(matrix.os, 'ubuntu')
       run: sudo apt-get install language-pack-de tzdata
+    - name: Install pyo dependencies
+      if: startsWith(matrix.os, 'ubuntu')
+      run: sudo apt-get install portaudio19-dev libsndfile1-dev libportmidi-dev liblo-dev
     - name: Install Python dependencies
       run: python -m pip install --upgrade tox codecov sphinx_rtd_theme
     - name: Run tests

.gitignore

@@ -10,6 +10,7 @@ __pycache__
 *.c
 
 # Other generated files
+notebooks/miles_stellar_spectra
 */version.py
 */cython_version.py
 htmlcov

.readthedocs.yml

@@ -1,15 +1,23 @@
 version: 2
 
 build:
-  image: latest
+  os: "ubuntu-24.04"
+  tools:
+    python: "3.11"
+  apt_packages:
+    - portaudio19-dev
+    - libsndfile1-dev
+    - libportmidi-dev
+    - liblo-dev
 
 python:
-  version: 3.7
   install:
     - method: pip
       path: .
       extra_requirements:
         - docs
         - all
+    - requirements: docs/requirements.txt
 
-formats: []
+sphinx:
+  configuration: docs/conf.py

CHANGES.rst

@@ -1,7 +1,10 @@
-0.2 (unreleased)
+0.11 (2025-01-31)
 ----------------
 
-- No changes yet
+- Fixes installation via pypi, confirmed to work with modern Python
+  (e.g., 3.11, 3.12), updated installation instructions and tips,
+  infrastructure improvements in CI, fixes automated documentation
+  builds, added __version__.
 
 0.1 (2020-11-25)
 ----------------

CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.1.0
+message: "Please cite the following works when using this software: https://ui.adsabs.harvard.edu/abs/2024ascl.soft08005B"
+authors:
+- family-names: Brasseur
+  given-names: C. E.
+- family-names: Fleming
+  given-names: S.
+- family-names: Kotler
+  given-names: J.
+- family-names: Meredith
+  given-names: K.
+title: "Astronify: Astronomical data sonification"
+version: 0.11
+date-released: 2025-01-31
+identifiers:
+ - type: "ascl-id"
+   value: "2408.005"
+ - type: "bibcode"
+   value: "2024ascl.soft08005B"
+abstract: "Astronify contains tools for sonifying astronomical data, specifically data series. Data series sonification takes a data table and maps one column to time, and one column to pitch. This technique is commonly used to sonify light curves, where observation time is scaled to listening time and flux is mapped to pitch. While Astronify’s sonification uses the columns “time” and “flux” by default, any two columns can be supplied and a sonification created."

DEVELOPER_DOC.rst

@@ -0,0 +1,104 @@
+Developer Documentation
+-----------------------
+
+This documentation is intended for code maintainers and developers as a guide, especially when preparing to merge and release a new version of the code.
+
+Installation
+^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    $ git clone https://github.com/spacetelescope/astronify.git
+    $ cd astronify
+    $ pip install .
+
+For active development, install in develop mode
+
+.. code-block:: bash
+
+    $ pip install -e .
+
+
+Testing
+^^^^^^^
+Testing is run with `tox <https://tox.readthedocs.io>`_ (``pip install tox``).
+Tests can be found in ``tests/`` sub-directories.
+
+.. code-block:: bash
+
+    $ tox -e test
+
+Tests can also be run directly with pytest:
+
+.. code-block:: bash
+
+    $ pip install -e .[test]
+    $ pytest
+
+
+Documentation
+^^^^^^^^^^^^^
+
+Documentation files are found in ``docs/``.
+
+We build the documentation with `tox <https://tox.readthedocs.io>`_ (``pip install tox``):
+
+.. code-block:: bash
+
+    $ tox -e build_docs
+
+You can also build the documentation with Sphinx directly using:
+
+.. code-block:: bash
+
+    $ cd docs
+    $ sphinx-build -M html . _build/
+
+The built docs will be in ``docs/_build/html/``, to view them go to ``file://</path/to/astronify/repo/>docs/_build/html/index.html`` in the browser of your choice.
+
+
+Release Protocol
+^^^^^^^^^^^^^^^^
+
+TO-BE-FINALIZED
+
+- Update the ``ci_workflows.yml`` under ``.github/workflows/`` to
+  remove any inactive branches and add your new development branch,
+  under the ``push`` section towards the top of the file.
+
+- Update the __init__.py file under the "astronify/" folder to update
+  the __version__ variable to match the upcoming release version. This
+  should be specified as a string.
+
+- Update the version information and release date in the CITATION.cff
+  file, located in the top-level directory to match the upcoming release version.
+
+- Update the "CHANGES.rst" file to add the new version, release date,
+  and summary of what's changing in this version.
+
+- Make a final commit to the branch, doing things like double checking 
+  Python versions, release dates, spell check documentation files, 
+  etc. Commit the final release with: 
+
+.. code-block:: bash
+
+    $ git commit -m "Preparing release <version>"
+
+- Tag the commit with the version, using the "v' in front of the tag,
+  even if the version in the __init__.py file does not.
+
+.. code-block:: bash
+
+    $ git tag -a v<version> -m "Release version <version>"
+
+- Make sure the `build` package is up-to-date:
+
+.. code-block:: bash
+
+    $ python -m build --sdist --outdir dist .
+
+- Twine upload.
+
+.. code-block:: bash
+
+    twine upload dist/<my_package*.tar.gz>