mwlmc

Milky Way - Large Magellanic Cloud simulation from Lilleengen et al. (2022)

This repository provides an interface to a simulation of the Milky Way and Large Magellanic Cloud (LMC) interaction.

Documentation

The main functionalities are explained in the tutorials:

Running orbits in the simulation with options for different potential setups and 2 examples of dwarf galaxies;
Accessing the simulation fields (i.e. densities, potentials, and forces) for different potential setups.

Due to GitHub file size constraints, we are unable to host the full resolution MW disc potential. We have provided a lower-resolution version in this repository. Therefore, computations in the inner Milky Way have modestly lower fidelity. If your use case is interested in the stellar disc, please email the authors for a full resolution disc basis. To illustrate the fidelity, an example of a Sun-like orbit in the deforming potential vs a rigid Milky Way is given in the orbit tutorial.

Installation notes

git clone --recursive https://github.com/sophialilleengen/mwlmc.git

pip install ./mwlmc

You may need to install eigen (v3), a header-only C++ library. As a header only library, it is sufficient to download the tarball, unpack, and copy the Eigen/ directory to /usr/local/include (which is already part of the search path for clang). You may also use brew install eigen if using a Mac with homebrew. If using macports, the command is sudo port install eigen3.

You may also need to install cmake. Using homebrew, try brew install cmake. If using macports, the corresponding command is sudo port install cmake.

Attributions

If you make use of this code, please cite the following papers

@ARTICLE{EXP,
       author = {{Petersen}, Michael S. and {Weinberg}, Martin D. and {Katz}, Neal},
        title = "{EXP: N-body integration using basis function expansions}",
      journal = {\mnras},
         year = 2022,
        month = mar,
       volume = {510},
       number = {4},
        pages = {6201-6217},
          doi = {10.1093/mnras/stab3639}
}

@ARTICLE{Lilleengen2023,
       author = {{Lilleengen}, Sophia and {Petersen}, Michael S. and {Erkal}, Denis and {Pe{\~n}arrubia}, Jorge and {Koposov}, Sergey E. and {Li}, Ting S. and {Cullinane}, Lara R. and {Ji}, Alexander P. and {Kuehn}, Kyler and {Lewis}, Geraint F. and {Mackey}, Dougal and {Pace}, Andrew B. and {Shipp}, Nora and {Zucker}, Daniel B. and {Bland-Hawthorn}, Joss and {Hilmi}, Tariq and {S5 Collaboration}},
        title = "{The effect of the deforming dark matter haloes of the Milky Way and the Large Magellanic Cloud on the Orphan-Chenab stream}",
      journal = {\mnras},
     keywords = {Galaxy: evolution, Galaxy: halo, Galaxy: kinematics and dynamics, Galaxy: structure, (galaxies:) Magellanic Clouds, Astrophysics - Astrophysics of Galaxies},
         year = 2023,
        month = jan,
       volume = {518},
       number = {1},
        pages = {774-790},
          doi = {10.1093/mnras/stac3108},
archivePrefix = {arXiv},
       eprint = {2205.01688},
 primaryClass = {astro-ph.GA},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2023MNRAS.518..774L},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

and consider citing this paper

@ARTICLE{Weinberg1999,
       author = {{Weinberg}, Martin D.},
        title = "{An Adaptive Algorithm for N-Body Field Expansions}",
      journal = {\aj},
         year = 1999,
        month = jan,
       volume = {117},
       number = {1},
        pages = {629-637},
          doi = {10.1086/300669}
}

License

mwlmc is free software made available under the MIT License. For details see the LICENSE file.

Authors

Mike Petersen - @michael-petersen - michael.petersen@roe.ac.uk
Sophia Lilleengen - @sophialilleengen - sophia.lilleengen@durham.ac.uk