adding some work-in-progress dev steps, adding __version__, updating …

…change log
spacetelescope · Jan 16, 2025 · 40a5b70 · 40a5b70
1 parent b359932
commit 40a5b70
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 7 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,7 +1,10 @@
-0.2 (unreleased)
+0.11 (2025-01-24)
 ----------------
 
-- No changes yet
+- Fixes installation via pypi, confirmed to work with modern Python
+  (e.g., 3.11), updated installation instructions and tips,
+  infrastructure improvements in CI, fixes automated documentation
+  builds, added __version__.
 
 0.1 (2020-11-25)
 ----------------

diff --git a/CITATION.cff b/CITATION.cff
@@ -10,13 +10,11 @@ authors:
 - family-names: Meredith
   given-names: K.
 title: "Astronify: Astronomical data sonification"
-version: 0.1
-date-released: 2020-11-30
+version: 0.11
+date-released: 2025-01-24
 identifiers:
  - type: "ascl-id"
    value: "2408.005"
- - type: "doi"
-   value: PLACEHOLDER
  - 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."
diff --git a/DEVELOPER_DOC.rst b/DEVELOPER_DOC.rst
@@ -60,4 +60,14 @@ The built docs will be in ``docs/_build/html/``, to view them go to ``file://</p
 Release Protocol
 ^^^^^^^^^^^^^^^^
 
-Coming soon.
+TO-BE-FINALIZED
+
+- 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.
diff --git a/astronify/__init__.py b/astronify/__init__.py
@@ -12,3 +12,4 @@
 from . import utils  # noqa
 
 __all__ = ["series", "simulator", "utils"]  # noqa
+__version__ = "0.11"
diff --git a/setup.cfg b/setup.cfg
@@ -6,6 +6,7 @@ license = BSD 3-Clause
 license_file = licenses/LICENSE.rst
 url = https://github.com/spacetelescope/astronify
 description = Sonification of astronomical data.
+version = attr: astronify.__version__
 long_description = file: README.rst
 long_description_content_type = text/x-rst
 edit_on_github = False
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,4 @@
		from . import utils # noqa

		__all__ = ["series", "simulator", "utils"] # noqa
		__version__ = "0.11"