jaxion 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

jaxion/analysis.py

@@ -4,10 +4,25 @@ import jaxdecomp as jd
 
 def radial_power_spectrum(data_cube, kx, ky, kz, box_size):
     """
-    Computes radially averaged power spectral density of data_cube (3D).
-    data_cube: jnp.ndarray (3D, must be cubic)
-    boxsize: float (physical size of box)
-    Returns: Pf (radial power spectrum), k (wavenumbers), total_power
+    Computes the radially averaged power spectral density of a 3D datacube.
+
+    Parameters
+    ----------
+        data_cube : jnp.ndarray
+            3D data cube, must be cubic
+        kx, ky, kz: jnp.ndarray
+            wavenumber grids in each dimension
+        box_size: float
+            physical size of box
+
+    Returns
+    -------
+        Pf: jnp.ndarray
+            radial power spectrum
+        k: jnp.ndarray
+            wavenumbers
+        total_power: float
+            total power
     """
     dim = data_cube.ndim
     nx = data_cube.shape[0]

jaxion/constants.py

@@ -1,13 +1,13 @@
 # Copyright (c) 2025 The Jaxion Team.
 
-# Physical Constants
-#
-# Jaxion uses a unit system of:
-# [L] = kpc
-# [V] = km/s
-# [M] = Msun
-#
-# other units are derived from these base units, e.g., [T] = [L]/[V] = kpc / (km/s) ~= 0.978 Gyr
+"""
+Physical constants in units of:
+[L] = kpc,
+[V] = km/s,
+[M] = Msun
+
+note: other units are derived from these base units, e.g., [T] = [L]/[V] = kpc / (km/s) ~= 0.978 Gyr
+"""
 
 constants = {
     "gravitational_constant": 4.30241002e-6,  # G / (kpc * (km/s)^2 / Msun)

jaxion/simulation.py

@@ -14,6 +14,7 @@ from .cosmology import get_supercomoving_time_interval, get_next_scale_factor
 from .utils import (
     set_up_parameters,
     print_parameters,
+    print_distributed_info,
     xmeshgrid,
     xmeshgrid_transpose,
     xzeros,
@@ -28,8 +29,11 @@ class Simulation:
 
     Parameters
     ----------
-      params (dict): The Python dictionary that contains the simulation parameters.
-                     Params can also be a string path to a checkpoint directory to load a saved simulation.
+        params : dict
+            The Python dictionary that contains the simulation parameters.
+            Params can also be a string path to a checkpoint directory to load a saved simulation.
+        sharding : jax.sharding.NamedSharding, optional
+            jax sharding used for distributed (multi-GPU) simulations
 
     """
 
@@ -69,10 +73,12 @@ class Simulation:
                     "hydro/particles sharding is not yet implemented."
                 )
 
-        if self.params["output"]["save"]:
-            if jax.process_index() == 0:
-                print("Simulation parameters:")
-                print_parameters(self.params)
+        # print info
+        if jax.process_index() == 0:
+            print("Simulation parameters:")
+            print_parameters(self.params)
+            if sharding is not None:
+                print_distributed_info()
 
         # jitted functions
         self.xmeshgrid_jit = jax.jit(
@@ -126,6 +132,9 @@ class Simulation:
 
     @property
     def resolution(self):
+        """
+        Return the (linear) resolution of the simulation
+        """
         return (
             self.params["domain"]["resolution_base"]
             * self.params["domain"]["resolution_multiplier"]
@@ -133,18 +142,30 @@ class Simulation:
 
     @property
     def num_particles(self):
+        """
+        Return the number of particles in the simulation
+        """
         return self.params["particles"]["num_particles"]
 
     @property
     def box_size(self):
+        """
+        Return the box size of the simulation (kpc)
+        """
         return self.params["domain"]["box_size"]
 
     @property
     def dx(self):
+        """
+        Return the cell size size of the simulation (kpc)
+        """
         return self.box_size / self.resolution
 
     @property
     def axion_mass(self):
+        """
+        Return the axion particle mass in the simulation (M_sun)
+        """
         return (
             self.params["quantum"]["m_22"]
             * 1.0e-22
@@ -152,16 +173,32 @@ class Simulation:
             / constants["speed_of_light"] ** 2
         )
 
+    @property
+    def m_per_hbar(self):
+        """
+        Return the mass per hbar in the simulation (M_sun / hbar)
+        """
+        return self.axion_mass / constants["reduced_planck_constant"]
+
     @property
     def sound_speed(self):
+        """
+        Return the isothermal gas sound speed in the simulation (km/s)
+        """
         return self.params["hydro"]["sound_speed"]
 
     @property
     def params(self):
+        """
+        Return the parameters of the simulation
+        """
         return self._params
 
     @property
     def grid(self):
+        """
+        Return the simulation grid
+        """
         hx = 0.5 * self.dx
         x_lin = jnp.linspace(hx, self.box_size - hx, self.resolution)
         xx, yy, zz = self.xmeshgrid_jit(x_lin)
@@ -169,6 +206,9 @@ class Simulation:
 
     @property
     def kgrid(self):
+        """
+        Return the simulation spectral grid
+        """
         nx = self.resolution
         k_lin = (2.0 * jnp.pi / self.box_size) * jnp.arange(-nx / 2, nx / 2)
         kx, ky, kz = self.xmeshgrid_transpose_jit(k_lin)
@@ -179,8 +219,10 @@ class Simulation:
 
     @property
     def quantum_velocity(self):
-        m_per_hbar = self.axion_mass / constants["reduced_planck_constant"]
-        return quantum_velocity(self.state["psi"], self.box_size, m_per_hbar)
+        """
+        Return the dark matter velocity field from the wavefunction
+        """
+        return quantum_velocity(self.state["psi"], self.box_size, self.m_per_hbar)
 
     def _calc_rho_bar(self, state):
         rho_bar = 0.0
@@ -214,6 +256,9 @@ class Simulation:
 
     @property
     def potential(self):
+        """
+        Return the gravitational potential
+        """
         kx, ky, kz = self.kgrid
         k_sq = kx**2 + ky**2 + kz**2
         return self._calc_grav_potential(self.state, k_sq)
@@ -235,7 +280,7 @@ class Simulation:
 
         # Simulation parameters
         dx = self.dx
-        m_per_hbar = self.axion_mass / constants["reduced_planck_constant"]
+        m_per_hbar = self.m_per_hbar
         box_size = self.box_size
 
         dt_fac = 1.0
@@ -372,14 +417,17 @@ class Simulation:
                 elapsed = time.time() - t_start_timer
                 est_total = elapsed / i * num_checkpoints
                 est_remaining = est_total - elapsed
+                num_cells = self.resolution**3
+                mcups = (num_cells * (i * nt_sub)) / (elapsed * 1.0e6)
                 if jax.process_index() == 0:
                     print(
-                        f"{percent:.1f}%: estimated time remaining (s): {est_remaining:.1f}"
+                        f"{percent:.1f}%: mcups={mcups:.1f}, estimated time left (s): {est_remaining:.1f}"
                     )
                 plot_sim(state, checkpoint_dir, i, self.params)
                 async_checkpoint_manager.wait_until_finished()
         else:
-            state = jax.lax.fori_loop(0, nt, _update, init_val=state)
+            carry = jax.lax.fori_loop(0, nt, _update, init_val=carry)
+            state, kx, ky, kz, k_sq = carry
         jax.block_until_ready(state)
         if jax.process_index() == 0:
             print("Simulation Run Time (s): ", time.time() - t_start_timer)
@@ -387,5 +435,8 @@ class Simulation:
         return state
 
     def run(self):
+        """
+        Run the simulation
+        """
         self.state = self._evolve(self.state)
         jax.block_until_ready(self.state)

jaxion/utils.py

@@ -5,6 +5,7 @@ from pathlib import Path
 import importlib.resources
 import json
 from importlib.metadata import version
+import jax
 import jax.numpy as jnp
 
 
@@ -12,6 +13,22 @@ def print_parameters(params):
     print(json.dumps(params, indent=2))
 
 
+def print_distributed_info():
+    for env_var in [
+        "SLURM_JOB_ID",
+        "SLURM_NTASKS",
+        "SLURM_NODELIST",
+        "SLURM_STEP_NODELIST",
+        "SLURM_STEP_GPUS",
+        "SLURM_GPUS",
+    ]:
+        print(f"{env_var}: {os.getenv(env_var, '')}")
+    print("Total number of processes: ", jax.process_count())
+    print("Total number of devices: ", jax.device_count())
+    print("List of devices: ", jax.devices())
+    print("Number of devices on this process: ", jax.local_device_count())
+
+
 def set_up_parameters(user_overwrites):
     # first load the default params
     params_path = importlib.resources.files("jaxion") / "params_default.json"

jaxion/visualization.py

@@ -13,15 +13,19 @@ def plot_sim(state, checkpoint_dir, i, params):
     if params["physics"]["quantum"]:
         nx = state["psi"].shape[0]
         rho_bar_dm = jnp.mean(jnp.abs(state["psi"]) ** 2)
-        rho_proj_dm = jax.experimental.multihost_utils.process_allgather(
-            jnp.log10(jnp.mean(jnp.abs(state["psi"]) ** 2, axis=2).T)
-        ).reshape(nx, nx)
+        rho_proj_dm = jnp.log10(
+            jax.experimental.multihost_utils.process_allgather(
+                jnp.mean(jnp.abs(state["psi"]) ** 2, axis=2), tiled=True
+            )
+        ).T
     if params["physics"]["hydro"]:
         nx = state["rho"].shape[0]
         rho_bar_gas = jnp.mean(state["rho"])
-        rho_proj_gas = jax.experimental.multihost_utils.process_allgather(
-            jnp.log10(jnp.mean(jnp.abs(state["rho"]) ** 2, axis=2).T)
-        ).reshape(nx, nx)
+        rho_proj_gas = jnp.log10(
+            jax.experimental.multihost_utils.process_allgather(
+                jnp.mean(state["rho"], axis=2), tiled=True
+            )
+        ).T
 
     # create plot on process 0
     if jax.process_index() == 0:
@@ -48,7 +52,7 @@ def plot_sim(state, checkpoint_dir, i, params):
                 sx = (state["pos"][:, 0] / box_size) * nx
                 sy = (state["pos"][:, 1] / box_size) * nx
                 plt.plot(
-                    sx, sy, color="cyan", marker=".", linestyle="None", markersize=2
+                    sx, sy, color="cyan", marker=".", linestyle="None", markersize=5
                 )
             ax.set_aspect("equal")
             ax.get_xaxis().set_visible(False)

{jaxion-0.0.3.dist-info → jaxion-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxion
-Version: 0.0.3
+Version: 0.0.5
 Summary: A differentiable simulation library for fuzzy dark matter in JAX
 Author-email: Philip Mocz <philip.mocz@gmail.com>
 License-Expression: Apache-2.0
@@ -32,8 +32,12 @@ Dynamic: license-file
 [![Repo Status][status-badge]][status-link]
 [![PyPI Version Status][pypi-badge]][pypi-link]
 [![Test Status][workflow-test-badge]][workflow-test-link]
+[![Coverage][coverage-badge]][coverage-link]
+[![Ruff][ruff-badge]][ruff-link]
+[![asv][asv-badge]][asv-link]
 [![Readthedocs Status][docs-badge]][docs-link]
 [![License][license-badge]][license-link]
+[![Software DOI][software-doi-badge]][software-doi-link]
 
 [status-link]:         https://www.repostatus.org/#active
 [status-badge]:        https://www.repostatus.org/badges/latest/active.svg
@@ -41,10 +45,19 @@ Dynamic: license-file
 [pypi-badge]:          https://img.shields.io/pypi/v/jaxion?label=PyPI&logo=pypi
 [workflow-test-link]:  https://github.com/JaxionProject/jaxion/actions/workflows/test-package.yml
 [workflow-test-badge]: https://github.com/JaxionProject/jaxion/actions/workflows/test-package.yml/badge.svg?event=push
+[coverage-link]:       https://app.codecov.io/gh/JaxionProject/jaxion
+[coverage-badge]:      https://codecov.io/github/jaxionproject/jaxion/graph/jaxion-server/badge.svg
+[ruff-link]:           https://github.com/astral-sh/ruff
+[ruff-badge]:          https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[asv-link]:            https://jaxionproject.github.io/jaxion-benchmarks/
+[asv-badge]:           https://img.shields.io/badge/benchmarked%20by-asv-blue.svg?style=flat
 [docs-link]:           https://jaxion.readthedocs.io
 [docs-badge]:          https://readthedocs.org/projects/jaxion/badge
 [license-link]:        https://opensource.org/licenses/Apache-2.0
 [license-badge]:       https://img.shields.io/badge/License-Apache_2.0-blue.svg
+[software-doi-link]:   https://doi.org/10.5281/zenodo.17438467
+[software-doi-badge]:  https://zenodo.org/badge/1072645376.svg
+
 
 A simple JAX-powered simulation library for numerical experiments of fuzzy dark matter, stars, gas + more!
 
@@ -63,34 +76,86 @@ Install with:
 pip install jaxion
 ```
 
-or, for GPU support use:
+or, for GPU support, use:
 
 ```console
 pip install jaxion[cuda12]
 ```
 
-Check out the `examples/` directory for demonstrations of using Jaxion.
+See the docs for more info on how to [build from source](https://jaxion.readthedocs.io/en/latest/pages/installation.html).
 
 
 ## Examples
 
+Check out the `examples/` directory for demonstrations of using Jaxion.
+
 <p align="center">
+  <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/cosmological_box">
+    <img src="examples/cosmological_box/movie.gif" alt="cosmological_box" width="128"/>
+  </a>
   <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/dynamical_friction">
     <img src="examples/dynamical_friction/movie.gif" alt="dynamical_friction" width="128"/>
   </a>
   <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/heating_gas">
     <img src="examples/heating_gas/movie.gif" alt="heating_gas" width="128"/>
   </a>
+  <br>
+  <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/heating_stars">
+    <img src="examples/heating_stars/movie.gif" alt="heating_stars" width="128"/>
+  </a>
+  <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/kinetic_condensation">
+    <img src="examples/kinetic_condensation/movie.gif" alt="kinetic_condensation" width="128"/>
+  </a>
+  <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/logo_inverse_problem">
+    <img src="examples/logo_inverse_problem/movie.gif" alt="logo_inverse_problem" width="128"/>
+  </a>
+  <br>
+  <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/soliton_binary_merger">
+    <img src="examples/soliton_binary_merger/movie.gif" alt="soliton_binary_merger" width="128"/>
+  </a>
+  <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/soliton_merger">
+    <img src="examples/soliton_merger/movie.gif" alt="soliton_merger" width="128"/>
+  </a>
   <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/tidal_stripping">
     <img src="examples/tidal_stripping/movie.gif" alt="tidal_stripping" width="128"/>
   </a>
 </p>
 
+
+## High-Performance
+
+Jaxion is scalable on multiple GPUs!
+
+<p align="center">
+  <a href="https://jaxion.readthedocs.io">
+    <img src="examples/soliton_binary_merger/timing.png" alt="timing" width="400"/>
+  </a>
+</p>
+
+
+## Contributing
+
+Jaxion welcomes community contributions of all kinds. Open an issue or fork the code and submit a pull request. Please check out the [Contributing Guidelines](CONTRIBUTING.md)
+
+
 ## Links
 
 * [Code repository](https://github.com/JaxionProject/jaxion) on GitHub (this page).
-* [Documentation](https://jaxion.readthedocs.io) for up-to-date information about installing and running jaxion.
+* [Documentation](https://jaxion.readthedocs.io) for up-to-date information about installing and using Jaxion.
 
 
 ## Cite this repository
 
+If you use this software, please cite it as below.
+
+```bibtex
+@software{Mocz_Jaxion_2025,
+   author = {Mocz, Philip},
+      doi = {10.5281/zenodo.17438467},
+    month = oct,
+    title = {{Jaxion}},
+      url = {https://github.com/JaxionProject/jaxion},
+  version = {0.0.4},
+     year = {2025}
+}
+```

jaxion-0.0.5.dist-info/RECORD

@@ -0,0 +1,17 @@
+jaxion/__init__.py,sha256=Hdji1UQ47lG24Pqcy6UUq9L0-qy6m9Ax41L0vIYzBto,164
+jaxion/analysis.py,sha256=4YT9Z2dkFoXwft3fQM1HyynVPlIdtRd80VtI2vWTyq4,1568
+jaxion/constants.py,sha256=HyY2ktKQakv78jD1yQvFdM3sklUJcPgDMYlTsSPQTxI,512
+jaxion/cosmology.py,sha256=UC1McXNTXGoPRYXn0nI2-csVkJWL-ZBNoCa44oU1b4w,2681
+jaxion/gravity.py,sha256=3brRZelKm-soXqk_Lt3SqhbZ00woJCraqwdMuR-KooA,291
+jaxion/hydro.py,sha256=KoJ02tRpAc4V3Ofzw4zbHLRaE2GdIatbOBE04_LsSRw,6980
+jaxion/params_default.json,sha256=9CJrhEPsv5zGEs7_WqFyuccCDipPCDhXgKzVdqOsOWE,2775
+jaxion/particles.py,sha256=pMopGvoZ0J_3EviD0WnTMmiebU9h2_8IO-p6I-E5DEU,3980
+jaxion/quantum.py,sha256=GWOpN6ipfEw-6Ah2zQpxS3oqeSt_iHMDSgnVYSjXY5E,3321
+jaxion/simulation.py,sha256=2YkHh3tUVvg5tUNnOxf4s7wGeuMntYUJcJWV0M-3Pl8,16267
+jaxion/utils.py,sha256=f8SvJjqzcW2K91qbPNqrsjfVjyPShuf50yoSHc0YqYE,4093
+jaxion/visualization.py,sha256=Vx_xuEE7BB1AkEGaY9KHNSIIDxJzUVT104o-3uglW8o,2966
+jaxion-0.0.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+jaxion-0.0.5.dist-info/METADATA,sha256=Ot_IWpsCk6l7KX94fCs4j1LLcJQLlQFmp-jYCyj_yWY,6378
+jaxion-0.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jaxion-0.0.5.dist-info/top_level.txt,sha256=S1OV2VdlDG_9UwpKOIji4itQGOS-VWUOWUi3GeXWzt0,7
+jaxion-0.0.5.dist-info/RECORD,,

jaxion-0.0.3.dist-info/RECORD

@@ -1,17 +0,0 @@
-jaxion/__init__.py,sha256=Hdji1UQ47lG24Pqcy6UUq9L0-qy6m9Ax41L0vIYzBto,164
-jaxion/analysis.py,sha256=UZpCvDr2ISDAgRoZFtuhvDk0QtN3mn5NxIoYYY8wzs8,1304
-jaxion/constants.py,sha256=b0vgqtezIEGp4O5JRJo3YK3eQC8AN6hmV84-4pYWgmc,528
-jaxion/cosmology.py,sha256=UC1McXNTXGoPRYXn0nI2-csVkJWL-ZBNoCa44oU1b4w,2681
-jaxion/gravity.py,sha256=3brRZelKm-soXqk_Lt3SqhbZ00woJCraqwdMuR-KooA,291
-jaxion/hydro.py,sha256=KoJ02tRpAc4V3Ofzw4zbHLRaE2GdIatbOBE04_LsSRw,6980
-jaxion/params_default.json,sha256=9CJrhEPsv5zGEs7_WqFyuccCDipPCDhXgKzVdqOsOWE,2775
-jaxion/particles.py,sha256=pMopGvoZ0J_3EviD0WnTMmiebU9h2_8IO-p6I-E5DEU,3980
-jaxion/quantum.py,sha256=GWOpN6ipfEw-6Ah2zQpxS3oqeSt_iHMDSgnVYSjXY5E,3321
-jaxion/simulation.py,sha256=3UrrHPJr0_39BiP86nQSl4ui8EsPHf9RrZ5hDobit5k,14884
-jaxion/utils.py,sha256=rT7NM0FNEgFwN7oTgTb-jkR66Iw0xYTHHxcoikYd1ag,3572
-jaxion/visualization.py,sha256=MJ3iqrvAem4RbozM79Ri2cNTIwKUV8o5X8M32FiDfbo,2928
-jaxion-0.0.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-jaxion-0.0.3.dist-info/METADATA,sha256=1C3fwJHJEBZYMEhxmTkKd7z_ZUrF15E3P0oS5XxrdjA,3579
-jaxion-0.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-jaxion-0.0.3.dist-info/top_level.txt,sha256=S1OV2VdlDG_9UwpKOIji4itQGOS-VWUOWUi3GeXWzt0,7
-jaxion-0.0.3.dist-info/RECORD,,