beorn 0.0.1

No project description provided

BEoRN

Bubbles during Epoch Of Reionization Numerical-simulator (BEORN) is a code simulating the state of the intergalactic medium (IGM) during cosmic dawn and reionization. More documentation can be found at its readthedocs page.

This package uses the template provided at https://github.com/sambit-giri/simple_python_package_template/

Package details

The package provides basic structure of a python package that can be used as a starting point to build your own.

INSTALLATION

To install the package from source, one should clone this package running the following::

git clone https://github.com/cosmic-reionization/BEoRN.git 

To install the package in the standard location, run the following in the root directory::

python setup.py install

In order to install it in a separate directory::

python setup.py install --home=directory

One can also install the latest version using pip by running the following command::

pip install git+https://github.com/cosmic-reionization/BEoRN.git

The dependencies should be installed automatically during the installation process. The list of required packages can be found in the requirements.txt file present in the root directory.

Tests

For testing, one can use pytest. To run all the test script, run the either of the following::

python -m pytest tests

CONTRIBUTING

If you find any bugs or unexpected behavior in the code, please feel free to open a Github issue. The issue page is also good if you seek help or have suggestions for us. For more details, please see here.

CREDIT