sxs 2024.0.20__tar.gz → 2024.0.22__tar.gz

{sxs-2024.0.20 → sxs-2024.0.22}/.github/workflows/build.yml

@@ -79,7 +79,7 @@ jobs:
 
       - name: Upload coverage
         if: "matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest'"
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 

{sxs-2024.0.20 → sxs-2024.0.22}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2024.0.20
-date-released: 2024-10-23
+version: 2024.0.22
+date-released: 2024-11-18

{sxs-2024.0.20 → sxs-2024.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2024.0.20
+Version: 2024.0.22
 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/
@@ -26,7 +26,6 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License

sxs-2024.0.22/sxs/__version__.py

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

{sxs-2024.0.20 → sxs-2024.0.22}/sxs/simulations/simulations.py

@@ -6,10 +6,10 @@ import pandas as pd
 
 class SimulationsDataFrame(pd.DataFrame):
     @property
-    def BHBH(self):
+    def BBH(self):
         """Restrict dataframe to just binary black hole systems"""
         return type(self)(self[self["object_types"] == "BHBH"])
-    BBH = BHBH
+    BHBH = BBH
     
     @property
     def BHNS(self):
@@ -65,9 +65,23 @@ class SimulationsDataFrame(pd.DataFrame):
         measured eccentricity means that the system is not
         hyperbolic or head-on.
         """
+        df = self.BBH
+        return type(df)(df[
+            np.isfinite(df["reference_eccentricity"])
+            & np.isfinite(df["remnant_mass"])
+        ])
+    
+    @property
+    def hyperbolic(self):
+        """Restrict dataframe to just hyperbolic systems
+        
+        The criterion used here is that the (normalized) ADM mass is
+        greater than 1.
+        """
+        total_mass = self["initial_mass1"] + self["initial_mass2"]
+        normalized_ADM = self["initial_ADM_energy"] / total_mass
         return type(self)(self[
-            np.isfinite(self["reference_eccentricity"])
-            & np.isfinite(self["remnant_mass"])
+            np.isfinite(total_mass) & (total_mass > 0) & (normalized_ADM > 1)
         ])
 
 

sxs-2024.0.20/sxs/__version__.py

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