sxs 2023.1.4__tar.gz → 2023.1.5__tar.gz

{sxs-2023.1.4 → sxs-2023.1.5}/CITATION.cff

@@ -10,5 +10,5 @@ authors:
 title: "The sxs package"
 license: MIT
 doi: 10.5281/zenodo.4034006
-version: 2023.1.4
-date-released: 2024-05-31
+version: 2023.1.5
+date-released: 2024-06-03

{sxs-2023.1.4 → sxs-2023.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sxs
-Version: 2023.1.4
+Version: 2023.1.5
 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-2023.1.5/docs/julia.md

@@ -0,0 +1,60 @@
+# Calling `sxs` from Julia
+
+Julia makes it extraordinarily simple to call Python packages from within Julia.
+
+!!! note
+
+    This page describes calling the `sxs` Python package from Julia.  Instructions
+    for calling Julia components from Python are found elsewhere.
+
+## Optional preliminary step: A new environment
+
+Julia also makes it much easier to work with "environments" than
+Python does.  If you want to create one from working with `sxs` in
+Julia, just create a new directory, `cd` into it, and run
+```bash
+julia --project=.
+```
+This will create a file named `Project.toml` in that directory
+containing this new environment.  Every time you need to work with
+this environment, you can tell Julia to use it by adding `--project=`
+followed by the path to that directory.  Alternatively, if Julia is already running,
+just hit `]` to enter the package manager, and run
+```julia
+activate /path/to/new/directory
+```
+
+## Getting Julia working with Python
+
+Once Julia is running (with the project you want), just run
+```julia
+import Pkg
+Pkg.add(["PythonCall", "CondaPkg"])
+using PythonCall
+import CondaPkg
+CondaPkg.add("numba", channel="numba")
+CondaPkg.add("llvmlite", channel="numba")
+CondaPkg.add("sxs", channel="conda-forge")
+```
+Once everything is installed, the main difference from Python is that
+you have to import the module as
+```julia
+sxs = pyimport("sxs")
+```
+Now, you can call functions from the `sxs` package nearly identically
+to how they are called in Python.  For example, the simple call to
+load a waveform from the README of this package is
+```julia
+waveform = sxs.load("SXS:BBH:0123/Lev/rhOverM", extrapolation_order=2)
+```
+That exact line works just in Julia like it does in Python.  (Note
+that strings must use double quotes in Julia, and Python's `True` and
+`False` are lowercased in Julia.)  And accessing members and methods
+of Python objects is just as natural.  For example, `waveform.t` and
+`waveform.data` return the same data as in Python.
+
+See the [PythonCall
+documentation](https://juliapy.github.io/PythonCall.jl/stable/pythoncall/)
+for more details on how to call Python from Julia, and any conversions
+that may need to be done.  Note that `pyconvert(Any, x)` will usually
+convert `x` to its most natural Julia equivalent.

{sxs-2023.1.4 → sxs-2023.1.5}/mkdocs.yml

@@ -30,6 +30,7 @@ nav:
     - "Horizons": "api/horizons.md"
     - "Waveforms": "api/waveforms.md"
   - "Calling from Mathematica": "mathematica.md"
+  - "Calling from Julia": "julia.md"
 
 theme:
   name: "material" # "readthedocs", "mkdocs", "material"
@@ -63,6 +64,7 @@ extra_javascript:
   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js
 
 markdown_extensions:
+  - admonition
   - toc:
       permalink: "#"
   - pymdownx.arithmatex:

sxs-2023.1.5/sxs/__version__.py

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

sxs-2023.1.4/sxs/__version__.py

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