franxavier / gdm_class_public

Public repository of an implementation of the Generalized Dark Matter (GDM) model in the Cosmic Linear Anisotropy Solving System

GDM_CLASS: an implementation of the Generalized Dark Matter model in the Cosmic Linear Anisotropy Solving System

Original CLASS authors: Julien Lesgourgues and Thomas Tram

GDM implementation authors: Stéphane Ilic, Michael Kopp, Daniel B. Thomas, Constantinos Skordis

Compiling GDM_CLASS and getting started

The process of compiling and running GDM_CLASS is strictly identical to the original CLASS code. Please refer to the CLASS code webpage and GitHub repository for detailed instructions.

Generalized Dark Matter model implementation

GDM_CLASS is a modification of the CLASS code which adds the phenomenologically motivated Generalized Dark Matter (GDM) model from Hu (1998). A detailed investigation of the theoretical aspects related to this model can be found in the following article.

The GDM model relaxes the assumptions about the pressureless nature of cold dark matter, and allows for non-zero sound speed and viscosity. The current implementation of the GDM model in GDM_CLASS allows the user to provide any choice for those three additional degree of freedom, in the form of three (smooth) binned functions: the equation of state, the sound speed, and the viscosity of the GDM fluid as a function of scale factor. The binning in time is entirely customizable by the user.

A thorough description of the CLASS code parameters is available in the explanatory.ini file. All additional parameters introduced in GDM_CLASS are described in a separate file, GDM.ini.

Python wrapper

Similarly to the original CLASS code, a Python wrapper is included in GDM_CLASS which is automatically compiled and installed at the same time as the main code (provided you use the make command and not simply the make class one). Since no modification were done to this wrapper, we also refer to the official CLASS documentation for details on the wrapper and its compilation.

Developing the code

Participation to the further development of the code is welcome. Feel free to clone the current repository, develop your own branch, and get it merged to the public distribution. You may as well open issues to discuss what new features you would like to see implemented.

License

The GDM_CLASS project is licensed under the MIT License. See the LICENSE file for more details.

Code of conduct

While CLASS is free to use, its authors request that publications using their code should cite at least the paper "CLASS II: Approximation schemes". Additionally, we have a similar request to the users of our modified code, and ask them to cite the paper "Dark Matter properties through cosmic history" (arXiv:2004.09572).

Support

To get support related to the main CLASS code, please open a new issue on the original CLASS repository. For an issue related to the GDM implementation, please open an issue in the present repository.