DarkMAGIC 🔮

The Dark Matter Ab initio phonon/maGnon Interaction Calculator (DarkMAGIC) is a python package for calculating dark matter interaction rates with phonons and magnons in real materials, based on properties calculated from first principles (mainly, density functional theory). It is based on the effective field theory developed by Trickle, Zhang and Zurek, and takes inspiration from the code they released with that paper and its precursors, PhonoDark.

DarkMAGIC is currently in pre-alpha testing, so not all features are implemented, the public API is subject to change, and not everything has been tested thoroughly. Development is in progress, and once at a satisfying stage, a manuscript will be prepared.

Features

• Calculate scattering rates, reach and daily modulation for single phonons and magnons.
• Supports phonon calculations using the frozen cell method or density functional perturbation theory with arbitrary DFT codes, based on the interface with phonopy.
• Supports magnon calculations using ab initio-based spin hamiltonians via rad-tools and TB2J.
• Parallelized with MPI, and highly performant.
• Easy to use Python API, with multiple pre-defined benchmark models.
• Portable HDF5 output format that allows the reconstruction of calculation as python objects. DarkMAGIC can also read and write HDF5 files in the format used by PhonoDark, but with limited functionality since it does not include all the parameters necessary to rebuild a calculation.

Planned Features (short term)

• In principle, all operators in the EFT paper are implemented for phonons, but only spin-independent operators are currently functional due to a recent refactoring. Only the magnetic dipole and anapole models for magnons are currently implemented. This will be dealt with soon.
• JIT compilation and shared-memory parallelism for increased performance.
• Command line interface.
• Plotting tools
• More documentation and examples. This website contains extensive, automatically-generated documentation for the python API, but it is not yet complete.

Planned Features (long term)

• Multi-phonon processes
• Absorption
• Support for fully first-principles time-dependent DFT magnon calculations instead of just spin Hamiltonians.

Installation

DarkMAGIC will soon be made available on pip. For now, please install it as

pip install git+https://github.com/Griffin-Group/DarkMAGIC

Citation

If you use DarkMAGIC in your research, please cite it as

@misc{darkmagic,
  author       = {Omar A. Ashour and Sin\'{e}ad M. Griffin},
  title        = { {DarkMAGIC} },
  month        = May,
  year         = 2024,
  doi          = {10.5281/zenodo.11124265},
  url          = {https://dx.doi.org/10.5281/zenodo.11124265}
}

Please also make sure to cite the work DarkMAGIC is based on, the effective field theory of Trickle, Zhang and Zurek.