sxs 2025.0.13__tar.gz → 2025.0.14__tar.gz

{sxs-2025.0.13 → sxs-2025.0.14}/CITATION.cff

@@ -16,5 +16,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2025.0.13
-date-released: 2025-05-12
+version: 2025.0.14
+date-released: 2025-05-14

{sxs-2025.0.13 → sxs-2025.0.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sxs
-Version: 2025.0.13
+Version: 2025.0.14
 Summary: Interface to data produced by the Simulating eXtreme Spacetimes collaboration
 Project-URL: Homepage, https://github.com/sxs-collaboration/sxs
 Project-URL: Documentation, https://sxs.readthedocs.io/
@@ -78,7 +78,7 @@ Description-Content-Type: text/markdown
 [![PyPI Version](https://img.shields.io/pypi/v/sxs?color=)](https://pypi.org/project/sxs/)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/sxs.svg?color=)](https://anaconda.org/conda-forge/sxs)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/sxs-collaboration/sxs/blob/main/LICENSE)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/moble/sxs_notebooks/main)
+[![Open with marimo](https://marimo.io/shield.svg)](https://data.black-holes.org/)
 
 
 # Simulating eXtreme Spacetimes package
@@ -142,11 +142,11 @@ for details.
 If you use this package and/or the data it provides in your research,
 please cite them, including the *specific version of the data* that
 you use (see below).  To help with this, we provide the function
-`sxs.cite`, which will print out a citation — in BibTeX format or just
-the DOIs — for the package, the most recent paper describing the
-catalog, the catalog data itself, and optionally individual
-simulations.
-
+`sxs.cite`.  Use `print(sxs.cite())` to see BibTeX citations for the
+version of this package you are using, the most recent paper
+describing the catalog, and the catalog data itself.  Use, e.g.,
+`print(sxs.cite("SXS:BBH:0001", "SXS:BBH:4001"))` to include citations
+for those specific simulations *and* the papers that introduced them.
 
 ## Usage
 
@@ -255,3 +255,30 @@ different methods; `h` and `psi4` are not just computed one from the
 other by a double integral or differentiation.  As a result, we
 generally recommend using `h` instead of `psi4` unless you have very
 specific requirements.
+
+## Contributing
+
+Contributions are welcome!  There are at least two ways to contribute
+to this codebase:
+
+1. If you find a bug or want to suggest an enhancement, use the [issue
+   tracker](https://github.com/sxs-collaboration/sxs/issues) on
+   GitHub.  It's a good idea to look through past issues, too, to see
+   if anybody has run into the same problem or made the same
+   suggestion before.
+2. If you will write or edit the python code, we use the [fork and
+   pull
+   request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
+   model.
+
+You are also allowed to make use of this code for other purposes, as
+detailed in the [MIT license](LICENSE).  For any type of contribution,
+please follow the [code of
+conduct](https://github.com/sxs-collaboration/.github/blob/master/CODE_OF_CONDUCT.md).
+
+## Reporting catalog data issues
+
+If you find an issue with our data or metadata, please let us know!
+[Fill out an issue with the catalog data
+template](https://github.com/sxs-collaboration/sxs/issues/new?template=catalog-data-issue-template.md)
+and we will take a look as soon as possible.

{sxs-2025.0.13 → sxs-2025.0.14}/README.md

@@ -3,7 +3,7 @@
 [![PyPI Version](https://img.shields.io/pypi/v/sxs?color=)](https://pypi.org/project/sxs/)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/sxs.svg?color=)](https://anaconda.org/conda-forge/sxs)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/sxs-collaboration/sxs/blob/main/LICENSE)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/moble/sxs_notebooks/main)
+[![Open with marimo](https://marimo.io/shield.svg)](https://data.black-holes.org/)
 
 
 # Simulating eXtreme Spacetimes package
@@ -67,11 +67,11 @@ for details.
 If you use this package and/or the data it provides in your research,
 please cite them, including the *specific version of the data* that
 you use (see below).  To help with this, we provide the function
-`sxs.cite`, which will print out a citation — in BibTeX format or just
-the DOIs — for the package, the most recent paper describing the
-catalog, the catalog data itself, and optionally individual
-simulations.
-
+`sxs.cite`.  Use `print(sxs.cite())` to see BibTeX citations for the
+version of this package you are using, the most recent paper
+describing the catalog, and the catalog data itself.  Use, e.g.,
+`print(sxs.cite("SXS:BBH:0001", "SXS:BBH:4001"))` to include citations
+for those specific simulations *and* the papers that introduced them.
 
 ## Usage
 
@@ -180,3 +180,30 @@ different methods; `h` and `psi4` are not just computed one from the
 other by a double integral or differentiation.  As a result, we
 generally recommend using `h` instead of `psi4` unless you have very
 specific requirements.
+
+## Contributing
+
+Contributions are welcome!  There are at least two ways to contribute
+to this codebase:
+
+1. If you find a bug or want to suggest an enhancement, use the [issue
+   tracker](https://github.com/sxs-collaboration/sxs/issues) on
+   GitHub.  It's a good idea to look through past issues, too, to see
+   if anybody has run into the same problem or made the same
+   suggestion before.
+2. If you will write or edit the python code, we use the [fork and
+   pull
+   request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
+   model.
+
+You are also allowed to make use of this code for other purposes, as
+detailed in the [MIT license](LICENSE).  For any type of contribution,
+please follow the [code of
+conduct](https://github.com/sxs-collaboration/.github/blob/master/CODE_OF_CONDUCT.md).
+
+## Reporting catalog data issues
+
+If you find an issue with our data or metadata, please let us know!
+[Fill out an issue with the catalog data
+template](https://github.com/sxs-collaboration/sxs/issues/new?template=catalog-data-issue-template.md)
+and we will take a look as soon as possible.

sxs-2025.0.14/docs/api/cite.md

@@ -0,0 +1,10 @@
+# `sxs.cite`
+
+For reasons of reproducibility — and for general academic integrity —
+it is important to cite the specific packages and data you use in your
+research.  In particular, it is absolutely vital to cite the specific
+version of the catalog of SXS simulations you use, as well as the
+version of this `sxs` package that you use.  The `sxs.cite` function
+provides those specific citations.
+
+::: sxs.cite

{sxs-2025.0.13 → sxs-2025.0.14}/docs/api/simulation.md

@@ -1,6 +1,6 @@
 # `Simulation` classes
 
-The `Simulation` classes are the primary interface for accessing
+The `Simulation` classes form the primary interface for accessing
 simulation data.  They are the top-level objects that contain all the
 data for a single simulation.  These classes are designed to be
 lightweight and to load data only when needed.
@@ -21,3 +21,6 @@ return the appropriate object.
 
 ## `Simulation_v2` class
 ::: sxs.simulations.simulation.Simulation_v2
+
+## `Simulation_v3` class
+::: sxs.simulations.simulation.Simulation_v3

{sxs-2025.0.13 → sxs-2025.0.14}/mkdocs.yml

@@ -30,6 +30,7 @@ nav:
     - "Time Series": "api/time_series.md"
     - "Horizons": "api/horizons.md"
     - "Waveforms": "api/waveforms.md"
+    - "Cite": "api/cite.md"
   - "Calling from Mathematica": "mathematica.md"
   - "Calling from Julia": "julia.md"
 

sxs-2025.0.14/sxs/__version__.py

@@ -0,0 +1 @@
+__version__ = "2025.0.14"

{sxs-2025.0.13 → sxs-2025.0.14}/sxs/citation.py

@@ -1,7 +1,7 @@
 def cite(*sxs_ids, bibtex=True):
     """Cite this package and/or data
 
-    Prints out a citation for the package, the most recent paper
+    Prints out a citation for this package, the most recent paper
     describing the catalog, the catalog data itself, and optionally
     individual simulations.
 

sxs-2025.0.13/sxs/__version__.py

@@ -1 +0,0 @@
-__version__ = "2025.0.13"