Welcome to the Asteria Python package!



0) Prerequisites

Python 3, with packages numpy, math, and scipy. 
If you want to use the Jupyter notebook that provides examples of how to use the package, Jupyter must also be installed.



1) Using the Asteria Python Package

The package is contained in the "asteria.py" file, and is imported as:

import asteria

This can be used in python scripts, or in a Jupyter notebook. We have included an example Jupyter notebook called "Asteria" in this directory, which has many examples of how to use the package.

The main syntax is:

asteria.set_elements([[fraction_1,mass_1],[fraction_2,mass_2],[fraction_3,mass_3]...])

asteria.multicapture(R,M,dens,v,mn,sig,mdm)

where:
R: The radius of the object in meters,
M: The mass in kg,
mn: The nucleon mass in GeV,
dens: The DM density in GeV/cm^3,
v: The DM velocity in m/s,
sigma: The DM-SM scattering cross section in cm^2,
mdm: The DM mass in GeV. 

Before executing asteria.multicapture, you must enter the elemental composition of the celestial object in asteria.set_elements, as shown above.


2) Support

For any questions, comments, or suggestions for the Asteria Python package, please contact rleane@slac.stanford.edu



Thank you for using the Asteria Python package!
