From 9e63ee17bd38d5d91625358da1a18494fde43cec Mon Sep 17 00:00:00 2001 From: Omar Ashour Date: Thu, 2 May 2024 17:29:47 -0700 Subject: [PATCH] Update pre-alpha disclaimer --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 1cf8cac..edd1917 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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.