sxs 2023.3.1__tar.gz → 2024.0.0__tar.gz

{sxs-2023.3.1 → sxs-2024.0.0}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2023.3.1
-date-released: 2024-07-25
+version: 2024.0.0
+date-released: 2024-08-06

{sxs-2023.3.1 → sxs-2024.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2023.3.1
+Version: 2024.0.0
 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/
@@ -54,19 +54,18 @@ Requires-Dist: mkdocs-jupyter; extra == 'docs'
 Requires-Dist: mkdocs-material; extra == 'docs'
 Requires-Dist: mkdocstrings-python; extra == 'docs'
 Provides-Extra: ecosystem
-Requires-Dist: corner>=2.1.0; extra == 'ecosystem'
-Requires-Dist: ipykernel>=5.3.4; extra == 'ecosystem'
-Requires-Dist: ipywidgets>=7.5.1; extra == 'ecosystem'
-Requires-Dist: jupyter-contrib-nbextensions>=0.5.1; extra == 'ecosystem'
-Requires-Dist: jupyterlab>=2.2.8; extra == 'ecosystem'
+Requires-Dist: ipykernel>=6.29; extra == 'ecosystem'
+Requires-Dist: ipywidgets>=8.0; extra == 'ecosystem'
+Requires-Dist: jupyterlab>=4.2; extra == 'ecosystem'
 Requires-Dist: line-profiler>=3.0.2; extra == 'ecosystem'
 Requires-Dist: matplotlib>=2.1.1; extra == 'ecosystem'
 Requires-Dist: memory-profiler>=0.57.0; extra == 'ecosystem'
 Requires-Dist: numpy-quaternion>=2023.0.4; extra == 'ecosystem'
 Requires-Dist: numpy<2.0,>=1.20; extra == 'ecosystem'
-Requires-Dist: qgrid>=1.3.1; extra == 'ecosystem'
+Requires-Dist: qgridnext>=2.0; extra == 'ecosystem'
 Requires-Dist: rise>=5.6.1; extra == 'ecosystem'
 Requires-Dist: scri>=2020.8.18; (sys_platform != 'win32') and extra == 'ecosystem'
+Requires-Dist: seaborn>=0.13; extra == 'ecosystem'
 Requires-Dist: spinsfast>=2022; (sys_platform != 'win32') and extra == 'ecosystem'
 Requires-Dist: sympy>=1.6.2; extra == 'ecosystem'
 Description-Content-Type: text/markdown
@@ -90,14 +89,13 @@ automatically select the newest or highest-resolution dataset for a given
 simulation, or return a range of versions or resolutions.  Currently, the
 high-level objects encapsulate
 
-  * Catalog — a listing of all data produced by the SXS collaboration
+  * Simulations — a catalog of all simulations produced by the SXS collaboration
+  * Simulation — an object encapsulating all data for a single simulation
   * Metadata — data describing the simulation parameters
   * Horizons — time-series data describing the apparent horizons
   * Waveforms — time-series data describing the extrapolated gravitational-wave
     modes
 
-The complete documentation is [hosted here](https://sxs.readthedocs.io/en/stable/).
-
 
 ## Installation
 
@@ -156,15 +154,16 @@ interactive jupyter notebooks that are actually running this code and some
 pre-downloaded data.  The following is just a very brief overview of the `sxs`
 package's main components.
 
-There are four important objects to understand in this package:
+There are five important objects to understand in this package:
 
 ```python
 import sxs
 
-catalog = sxs.load("catalog")
-metadata = sxs.load("SXS:BBH:0123/Lev/metadata.json")
-horizons = sxs.load("SXS:BBH:0123/Lev/Horizons.h5")
-waveform = sxs.load("SXS:BBH:0123/Lev/rhOverM", extrapolation_order=2)
+simulations = sxs.load("simulations")
+sxs_bbh_1234 = sxs.load("SXS:BBH:1234")
+metadata = sxs_bbh_1234.metadata
+horizons = sxs_bbh_1234.horizons
+h = sxs_bbh_1234.h
 ```
 
 [The `catalog`

{sxs-2023.3.1 → sxs-2024.0.0}/README.md

@@ -17,14 +17,13 @@ automatically select the newest or highest-resolution dataset for a given
 simulation, or return a range of versions or resolutions.  Currently, the
 high-level objects encapsulate
 
-  * Catalog — a listing of all data produced by the SXS collaboration
+  * Simulations — a catalog of all simulations produced by the SXS collaboration
+  * Simulation — an object encapsulating all data for a single simulation
   * Metadata — data describing the simulation parameters
   * Horizons — time-series data describing the apparent horizons
   * Waveforms — time-series data describing the extrapolated gravitational-wave
     modes
 
-The complete documentation is [hosted here](https://sxs.readthedocs.io/en/stable/).
-
 
 ## Installation
 
@@ -83,15 +82,16 @@ interactive jupyter notebooks that are actually running this code and some
 pre-downloaded data.  The following is just a very brief overview of the `sxs`
 package's main components.
 
-There are four important objects to understand in this package:
+There are five important objects to understand in this package:
 
 ```python
 import sxs
 
-catalog = sxs.load("catalog")
-metadata = sxs.load("SXS:BBH:0123/Lev/metadata.json")
-horizons = sxs.load("SXS:BBH:0123/Lev/Horizons.h5")
-waveform = sxs.load("SXS:BBH:0123/Lev/rhOverM", extrapolation_order=2)
+simulations = sxs.load("simulations")
+sxs_bbh_1234 = sxs.load("SXS:BBH:1234")
+metadata = sxs_bbh_1234.metadata
+horizons = sxs_bbh_1234.horizons
+h = sxs_bbh_1234.h
 ```
 
 [The `catalog`

sxs-2024.0.0/docs/api/simulation.md

@@ -0,0 +1,23 @@
+# `Simulation` classes
+
+The `Simulation` classes are 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.
+
+Note that the user will not usually need to interact with these
+classes (or the factory) automatically; the `sxs.load` function will
+automatically select the appropriate version of the simulation and
+return the appropriate object.
+
+## `sxs.Simulation` factory function
+::: sxs.Simulation
+
+## `SimulationBase` class
+::: sxs.simulations.simulation.SimulationBase
+
+## `Simulation_v1` class
+::: sxs.simulations.simulation.Simulation_v1
+
+## `Simulation_v2` class
+::: sxs.simulations.simulation.Simulation_v2

sxs-2024.0.0/docs/api/simulations.md

@@ -0,0 +1,3 @@
+# `Simulations` class
+
+::: sxs.Simulations