Skip to content

Commit

Permalink
Update pre-alpha disclaimer
Browse files Browse the repository at this point in the history
  • Loading branch information
oashour authored May 3, 2024
1 parent b40e6f5 commit 9e63ee1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The **D**ark **M**atter ***A****b* *initio* phonon/ma**G**non **I**nteraction **C**alculator (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](https://arxiv.org/abs/2009.13534), and takes inspiration from the code they released with that paper, [PhonoDark](https://github.com/tanner-trickle/PhonoDark).

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

## Features
* Calculate scattering rates from single phonons and magnons.
Expand Down

0 comments on commit 9e63ee1

Please sign in to comment.