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

jaxion/{params_default.json → defaults.json}

@@ -75,6 +75,10 @@
     "m_22": { 
       "default": 1.0,
       "description": "axion mass [10^{-22} eV]."
+    },
+    "f_15": { 
+      "default": 0.0,
+      "description": "self-interaction strength [10^{15} GeV]."
     }
   },
   "hydro": {

jaxion/gravity.py

@@ -5,6 +5,6 @@ import jaxdecomp as jd
 
 
 def calculate_gravitational_potential(rho, k_sq, G, rho_bar):
-    Vhat = -jd.fft.pfft3d(4.0 * jnp.pi * G * (rho - rho_bar)) / (k_sq + (k_sq == 0))
-    V = jnp.real(jd.fft.pifft3d(Vhat))
+    V_hat = -jd.fft.pfft3d(4.0 * jnp.pi * G * (rho - rho_bar)) / (k_sq + (k_sq == 0))
+    V = jnp.real(jd.fft.pifft3d(V_hat))
     return V

jaxion/simulation.py

@@ -62,9 +62,10 @@ class Simulation:
                 self.params["physics"]["hydro"]
                 or self.params["physics"]["particles"]
                 or self.params["physics"]["external_potential"]
+                or self.params["quantum"]["f_15"] != 0.0
             ):
                 raise NotImplementedError(
-                    "Cosmological hydro/particles/external_potential physics is not yet implemented."
+                    "Cosmological hydro/particles/external_potential/SI is not yet implemented."
                 )
 
         if self.params["physics"]["hydro"] or self.params["physics"]["particles"]:
@@ -94,6 +95,12 @@ class Simulation:
             xones, static_argnums=0, in_shardings=None, out_shardings=sharding
         )
 
+        # customfunctions
+        self.custom_kick = None
+        self.custom_drift = None
+        self.custom_density = None
+        self.custom_plot = None
+
         # simulation state
         self.state = {}
         self.state["t"] = 0.0
@@ -173,6 +180,23 @@ class Simulation:
             / constants["speed_of_light"] ** 2
         )
 
+    @property
+    def scattering_length(self):
+        """
+        Return the axion self-interaction scattering length in the simulation (kpc)
+        """
+        f_15 = self.params["quantum"]["f_15"]
+        if f_15 == 0.0:
+            return 0.0
+        else:
+            f = f_15 * 1.0e24 * constants["electron_volt"]
+            sign = 1.0 if f > 0 else -1.0
+            hbar = constants["reduced_planck_constant"]
+            c = constants["speed_of_light"]
+            m = self.axion_mass
+            a_s = sign * (hbar * c**3 * m) / (32.0 * jnp.pi * (f**2))
+            return a_s
+
     @property
     def m_per_hbar(self):
         """
@@ -224,6 +248,13 @@ class Simulation:
         """
         return quantum_velocity(self.state["psi"], self.box_size, self.m_per_hbar)
 
+    @property
+    def rho_bar(self):
+        """
+        Return the mean density of the simulation
+        """
+        return self._calc_rho_bar(self.state)
+
     def _calc_rho_bar(self, state):
         rho_bar = 0.0
         if self.params["physics"]["quantum"]:
@@ -235,6 +266,8 @@ class Simulation:
             n_particles = self.num_particles
             box_size = self.box_size
             rho_bar += m_particle * n_particles / box_size
+        if self.custom_density is not None:
+            rho_bar += jnp.mean(self.custom_density(state))
         return rho_bar
 
     def _calc_grav_potential(self, state, k_sq):
@@ -248,6 +281,8 @@ class Simulation:
             rho_tot += state["rho"]
         if self.params["physics"]["particles"]:
             rho_tot += bin_particles(state["pos"], self.dx, self.resolution, m_particle)
+        if self.custom_density is not None:
+            rho_tot += self.custom_density(state)
         if self.params["physics"]["cosmology"]:
             scale_factor = 1.0 / (1.0 + state["redshift"])
             rho_bar *= scale_factor
@@ -280,8 +315,9 @@ class Simulation:
 
         # Simulation parameters
         dx = self.dx
-        m_per_hbar = self.m_per_hbar
         box_size = self.box_size
+        num_cells = self.resolution**3
+        m_per_hbar = self.m_per_hbar
 
         dt_fac = 1.0
         dt_kin = dt_fac * (m_per_hbar / 6.0) * (dx * dx)
@@ -290,8 +326,20 @@ class Simulation:
         t_span = t_end - t_start
         state["t"] = t_start
 
+        use_quantum = self.params["physics"]["quantum"]
+        use_gravity = self.params["physics"]["gravity"]
+        use_hydro = self.params["physics"]["hydro"]
+        use_particles = self.params["physics"]["particles"]
+        use_cosmology = self.params["physics"]["cosmology"]
+        use_external_potential = self.params["physics"]["external_potential"]
+        save = self.params["output"]["save"]
+        use_custom = self.custom_kick is not None or self.custom_drift is not None
+        if use_custom:
+            custom_kick = self.custom_kick
+            custom_drift = self.custom_drift
+
         # cosmology
-        if self.params["physics"]["cosmology"]:
+        if use_cosmology:
             z_start = self.params["time"]["start"]
             z_end = self.params["time"]["end"]
             omega_matter = self.params["cosmology"]["omega_matter"]
@@ -303,6 +351,17 @@ class Simulation:
             state["t"] = 0.0
             state["redshift"] = z_start
 
+        # self-interaction
+        a_s = self.scattering_length
+        c = constants["speed_of_light"]
+        m = self.axion_mass
+        si_coeff = None
+        si_coeff2 = None
+        do_self_interaction = a_s != 0.0
+        if do_self_interaction:
+            si_coeff = (4.0 * jnp.pi) * (a_s / m) / m_per_hbar**2
+            si_coeff2 = (32.0 * jnp.pi**2 / 3.0) * (a_s / (m * c)) ** 2 / m_per_hbar**5
+
         # hydro
         c_sound = self.params["hydro"]["sound_speed"]
 
@@ -317,16 +376,14 @@ class Simulation:
         k_sq = None
 
         # Fourier space variables
-        if self.params["physics"]["gravity"] or self.params["physics"]["quantum"]:
+        if use_gravity or use_quantum:
             kx, ky, kz = self.kgrid
             k_sq = kx**2 + ky**2 + kz**2
 
         # Checkpointer
-        if self.params["output"]["save"]:
+        if save:
             options = ocp.CheckpointManagerOptions()
-            checkpoint_dir = checkpoint_dir = os.path.join(
-                os.getcwd(), self.params["output"]["path"]
-            )
+            checkpoint_dir = os.path.join(os.getcwd(), self.params["output"]["path"])
             path = os.path.join(os.getcwd(), checkpoint_dir)
             if jax.process_index() == 0:
                 path = ocp.test_utils.erase_and_create_empty(checkpoint_dir)
@@ -336,80 +393,86 @@ class Simulation:
 
         def _kick(state, kx, ky, kz, k_sq, dt):
             # Kick (half-step)
-            if (
-                self.params["physics"]["gravity"]
-                and self.params["physics"]["external_potential"]
-            ):
+            if use_gravity and use_external_potential:
                 V = self._calc_grav_potential(state, k_sq) + state["V_ext"]
-            elif self.params["physics"]["gravity"]:
+            elif use_gravity:
                 V = self._calc_grav_potential(state, k_sq)
-            elif self.params["physics"]["external_potential"]:
+            elif use_external_potential:
                 V = state["V_ext"]
 
-            if (
-                self.params["physics"]["gravity"]
-                or self.params["physics"]["external_potential"]
-            ):
-                if self.params["physics"]["quantum"]:
-                    state["psi"] = quantum_kick(state["psi"], V, m_per_hbar, dt)
-                if self.params["physics"]["hydro"]:
+            if use_gravity or use_external_potential:
+                if use_quantum:
+                    if do_self_interaction:
+                        rho = jnp.abs(state["psi"]) ** 2
+                        V_prime = V + si_coeff * rho + si_coeff2 * rho**2
+                        state["psi"] = quantum_kick(
+                            state["psi"], V_prime, m_per_hbar, dt
+                        )
+                    else:
+                        state["psi"] = quantum_kick(state["psi"], V, m_per_hbar, dt)
+                if use_hydro:
                     state["vx"], state["vy"], state["vz"] = hydro_accelerate(
                         state["vx"], state["vy"], state["vz"], V, kx, ky, kz, dt
                     )
-                if self.params["physics"]["particles"]:
+                if use_particles:
                     state["vel"] = particles_accelerate(
                         state["vel"], state["pos"], V, kx, ky, kz, dx, dt
                     )
+                if use_custom:
+                    state = custom_kick(state, V, dt)
+
+            return state
 
         def _drift(state, k_sq, dt):
             # Drift (full-step)
-            if self.params["physics"]["quantum"]:
+            if use_quantum:
                 state["psi"] = quantum_drift(state["psi"], k_sq, m_per_hbar, dt)
-            if self.params["physics"]["hydro"]:
+            if use_hydro:
                 state["rho"], state["vx"], state["vy"], state["vz"] = hydro_fluxes(
                     state["rho"], state["vx"], state["vy"], state["vz"], dt, dx, c_sound
                 )
-            if self.params["physics"]["particles"]:
+            if use_particles:
                 state["pos"] = particles_drift(state["pos"], state["vel"], dt, box_size)
+            if use_custom:
+                state = custom_drift(state, k_sq, dt)
+
+            return state
 
-        @jax.jit
         def _update(_, carry):
             # Update the simulation state by one timestep
             # according to a 2nd-order `kick-drift-kick` scheme
             state, kx, ky, kz, k_sq = carry
-            _kick(state, kx, ky, kz, k_sq, 0.5 * dt)
-            _drift(state, k_sq, dt)
+            state = _kick(state, kx, ky, kz, k_sq, 0.5 * dt)
+            state = _drift(state, k_sq, dt)
             # update time & redshift
             state["t"] += dt
-            if self.params["physics"]["cosmology"]:
+            if use_cosmology:
                 scale_factor = get_next_scale_factor(
-                    state["redshift"],
-                    dt,
-                    self.params["cosmology"]["omega_matter"],
-                    self.params["cosmology"]["omega_lambda"],
-                    self.params["cosmology"]["little_h"],
+                    state["redshift"], dt, omega_matter, omega_lambda, little_h
                 )
                 state["redshift"] = 1.0 / scale_factor - 1.0
-            _kick(state, kx, ky, kz, k_sq, 0.5 * dt)
+            state = _kick(state, kx, ky, kz, k_sq, 0.5 * dt)
 
             return state, kx, ky, kz, k_sq
 
         # save initial state
         if jax.process_index() == 0:
             print(f"Starting simulation (res={self.resolution}, nt={nt}) ...")
-        if self.params["output"]["save"]:
+        if save:
             with open(os.path.join(checkpoint_dir, "params.json"), "w") as f:
                 json.dump(self.params, f, indent=2)
             async_checkpoint_manager.save(0, args=ocp.args.StandardSave(state))
             plot_sim(state, checkpoint_dir, 0, self.params)
+            if self.custom_plot is not None:
+                self.custom_plot(state, checkpoint_dir, 0, self.params)
             async_checkpoint_manager.wait_until_finished()
 
         # Simulation Main Loop
         t_start_timer = time.time()
-        if self.params["output"]["save"]:
+        if save:
             for i in range(1, num_checkpoints + 1):
                 carry = jax.lax.fori_loop(0, nt_sub, _update, init_val=carry)
-                state, kx, ky, kz, k_sq = carry
+                state, _, _, _, _ = carry
                 jax.block_until_ready(state)
                 # save state
                 async_checkpoint_manager.save(i, args=ocp.args.StandardSave(state))
@@ -417,17 +480,18 @@ 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}%: mcups={mcups:.1f}, estimated time left (s): {est_remaining:.1f}"
                     )
                 plot_sim(state, checkpoint_dir, i, self.params)
+                if self.custom_plot is not None:
+                    self.custom_plot(state, checkpoint_dir, i, self.params)
                 async_checkpoint_manager.wait_until_finished()
         else:
             carry = jax.lax.fori_loop(0, nt, _update, init_val=carry)
-            state, kx, ky, kz, k_sq = carry
+            state, _, _, _, _ = carry
         jax.block_until_ready(state)
         if jax.process_index() == 0:
             print("Simulation Run Time (s): ", time.time() - t_start_timer)

jaxion/utils.py

@@ -31,7 +31,7 @@ def print_distributed_info():
 
 def set_up_parameters(user_overwrites):
     # first load the default params
-    params_path = importlib.resources.files("jaxion") / "params_default.json"
+    params_path = importlib.resources.files("jaxion") / "defaults.json"
     with params_path.open("r", encoding="utf-8") as f:
         params = json.load(f)
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jaxion
-Version: 0.0.5
+Version: 0.0.6
 Summary: A differentiable simulation library for fuzzy dark matter in JAX
 Author-email: Philip Mocz <philip.mocz@gmail.com>
 License-Expression: Apache-2.0
@@ -68,7 +68,7 @@ Jaxion is built for multi-GPU scalability and is fully differentiable. It is a h
 Jaxion is the simpler companion project to differentiable astrophysics code [Adirondax](https://github.com/AdirondaxProject/adirondax)
 
 
-## Getting started
+## Install Jaxion
 
 Install with:
 
@@ -87,7 +87,7 @@ See the docs for more info on how to [build from source](https://jaxion.readthed
 
 ## Examples
 
-Check out the `examples/` directory for demonstrations of using Jaxion.
+Check out the [`examples/`](https://github.com/JaxionProject/jaxion/tree/main/examples/) directory for demonstrations of using Jaxion.
 
 <p align="center">
   <a href="https://github.com/JaxionProject/jaxion/tree/main/examples/cosmological_box">

{jaxion-0.0.5.dist-info → jaxion-0.0.6.dist-info}/RECORD

@@ -2,16 +2,16 @@ 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/defaults.json,sha256=EqFHV9HlLIRvTJrfbT5-AI0GfCLBd0ViwTeUV_B8YIw,2883
+jaxion/gravity.py,sha256=2smqy_jjmr0VkMGzLPMYjLahHBMfZ2nNUx0gUiTWcDI,293
 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/simulation.py,sha256=rxncry9xPAVpohGkLqSo9vft-qaGTnh4f-wKk-A-Y2A,18496
+jaxion/utils.py,sha256=OCpJ3crZqr5VFacymYzi5BkRqFCVBcneoS44wV9mZPg,4087
 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.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+jaxion-0.0.6.dist-info/METADATA,sha256=uNykshiiqSIPVw2UM44_zREemfnkaJlGdVqZKyi7X-8,6440
+jaxion-0.0.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jaxion-0.0.6.dist-info/top_level.txt,sha256=S1OV2VdlDG_9UwpKOIji4itQGOS-VWUOWUi3GeXWzt0,7
+jaxion-0.0.6.dist-info/RECORD,,