GalMag is a Python package for computing galactic magnetic fields based on mean field dynamo theory.
The code computes two separate components of the galactic magnetic field: a disc and a halo component. Both are solutions to the mean field dynamo equation for the choice of parameters and galaxy rotation curves specified by the user.
For more details about the physics, we refer the reader to the code paper [1] .
GalMag is open-source software available under the GNU General Public License v3 (GPL-3).
We refer the reader to the the tutorial jupyter notebook which contains both a quick tour through the functionality and a description of the features and usage of the package.
For more detailed code documentation see http://galmag.readthedocs.io/
One can download the latest release from https://github.com/luizfelippesr/galmag/releases
The current (development) version can be obtained by cloning the repository:
git clone git@github.com:luizfelippesr/galmag.git
To install, one can simply run the command:
pip install .
if you are (both) not using conda and do not have root privileges, the following may help:
python setup.py install --user
and the galmag python package will be available in one's system.
| [1] | Shukurov et al., "A physical approach to modelling large-scale galactic magnetic fields", A&A 623, A113 (2019). |