https://github.com/nickhand/classylss
a lightweight Python binding of the CLASS CMB Boltzmann code
https://github.com/nickhand/classylss
boltzmann-code class cmb cosmic-microwave-background cosmology large-scale-structure python
Last synced: about 2 months ago
JSON representation
a lightweight Python binding of the CLASS CMB Boltzmann code
- Host: GitHub
- URL: https://github.com/nickhand/classylss
- Owner: nickhand
- License: gpl-3.0
- Created: 2016-06-21T00:28:35.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-07-20T21:35:54.000Z (10 months ago)
- Last Synced: 2025-03-21T13:58:25.387Z (2 months ago)
- Topics: boltzmann-code, class, cmb, cosmic-microwave-background, cosmology, large-scale-structure, python
- Language: Python
- Homepage: http://classylss.rtfd.io
- Size: 416 KB
- Stars: 10
- Watchers: 4
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
classylss
----------
.. image:: https://img.shields.io/pypi/v/classylss.svg
:alt: PyPi
:target: https://pypi.python.org/pypi/classylss/
.. image:: https://api.travis-ci.org/nickhand/classylss.svg
:alt: Build Status
:target: https://travis-ci.org/nickhand/classylss/
.. image:: https://zenodo.org/badge/61589760.svg
:target: https://zenodo.org/badge/latestdoi/61589760
|
A lightweight Python binding of the CMB Boltzmann code `CLASS`, with an emphasis on the routines that are important for large-scale structure calculations. The main modules of the CLASS code are exposed to the user via a Cython wrapper.
.. _`CLASS` : http://class-code.net
Documentation
-------------
Installation instructions, examples, and API reference are availabe on ReadTheDocs: http://classylss.readthedocs.io/.
Dependencies
------------
The package is lightweight and the only dependencies are:
- numpy
- cython
The CLASS code will automatically be downloaded and compiled, and is thus, not an external dependency for the user. However, the user will need a valid C compiler to compile the CLASS code. The version of CLASS compiled by the code is stored in the variable ``classylss.class_version``.
Installation
------------
The package can be installed as part of the Anaconda package manager using
.. code:: bash
conda install -c bccp classylss
The package can also be installed via the `pip` command
.. code:: bash
pip install classylss
The package can be also be downloaded from github using
.. code:: bash
git clone https://github.com/nickhand/classylss.git
cd classylss
If ``CLASS`` is not built succesfully, the user
can edit the default configuration variables in ``depends/class.cfg``, which are used
when building the ``CLASS`` library.
To verify that the installation has succeeded, run:
.. code-block:: python
import classylss
Examples
--------
See the tests of the code in ``classylss/tests/`` for examples of using each of the main CLASS modules.
Feature Requests
----------------
Additional features of the CLASS code that are not yet implemented can be exposed via the Cython wrapper relatively easily. We encourage users to open up a GitHub issue with any feature requests.