sxs 2024.0.18__tar.gz → 2024.0.19__tar.gz

{sxs-2024.0.18 → sxs-2024.0.19}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.18
-date-released: 2024-10-09
+version: 2024.0.19
+date-released: 2024-10-16

{sxs-2024.0.18 → sxs-2024.0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.18
+Version: 2024.0.19
 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/

sxs-2024.0.19/docs/api/simulations.md

@@ -0,0 +1,7 @@
+# `Simulations` class
+
+::: sxs.Simulations
+
+# `SimulationsDataFrame` class
+
+::: sxs.simulations.simulations.SimulationsDataFrame

sxs-2024.0.19/sxs/__version__.py

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

{sxs-2024.0.18 → sxs-2024.0.19}/sxs/simulations/simulations.py

@@ -70,6 +70,20 @@ class Simulations(collections.OrderedDict):
 
     simulations = sxs.load("simulations")
     ```
+
+    Note SXS members may also wish to read a local copy of the
+    simulation annex, which can be done with
+    ```python
+    simulations = sxs.load("simulations", annex_dir="/path/to/SimulationAnnex.git")
+    ```
+    which will re-read the annex (which may take about a minute), or
+    ```python
+    simulations = sxs.load("simulations", local=True)
+    ```
+    if the annex has not been updated since the last time you
+    used the `annex_dir` argument.  Once you have done this,
+    calls to `sxs.load` will automatically use this local copy
+    of the simulations.
     """
     last_modified_url = "https://api.github.com/repos/sxs-collaboration/sxs/contents/simulations.json?ref=simulations"
     url = "https://github.com/sxs-collaboration/sxs/raw/simulations/simulations.json"

sxs-2024.0.18/docs/api/simulations.md

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

sxs-2024.0.18/sxs/__version__.py

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