The purpose of this project is to provide Python interfaces to various microphysics codes commonly used in astrophysical simulations. At the moment, the planned scope includes the following:
- Equations of State
- Opacity
Others may be added if there is sufficient interest.
The interfaces developed should:
- Wherever possible make use of existing Python infrastructure, particularly NumPy and Scipy.
- Be well documented.
- Take inputs and give outputs in C.G.S.K. (centimeter, gram, second, kelvin) units. The only exception to this is for mean particle masses, which are taken and given in units of the proton mass.
- Have units noted both near the relevant functions in the code and in the broader documentation.
- Depend only on Python, NumPy, SciPy, and related standard Python packages. Compilers are okay (but see 7 below).
- Rely on as simple a build system as possible, and be platform-independent.
- Require minimal modifications to the underlying tables or the routines which come with them. Where required, these modifications must be documented clearly, and the unmodified files must be distributed as well.
- Be distributed with the relevant tables/routines.
- Accept inputs in the form of both scalars and NumPy arrays, and provide output with the same dimensionality as the input, with exceptions made for routines which return a vector of outputs corresponding to distinct physical quantities.
- Come with test cases and examples.
Helper scripts for merging outputs from multiple different codes are also welcome and encouraged, though this should result in a strictly one-way dependency (i.e. the individual code/table interfaces should not depend in any way on the helper scripts).
The tables currently contained in this project are:
OPAL2005EOS - http://opalopacity.llnl.gov/EOS_2005/
SCVH EOS - http://adsabs.harvard.edu/abs/1995ApJS...99..713S
Finally, this is all very much a work in progress, so if any of the above doesn't currently hold true, please consider helping make it so!
- Adam S. Jermyn