Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.96 KB

INSTALL.md

File metadata and controls

49 lines (32 loc) · 1.96 KB

Installation

Requirements

bajes is compatible with Python v3.7 or higher. Before the installation, please check that the required Python modules are provided,

astropy, numpy, scipy

If you are interested in using the provided pipeline for gravitational-wave and multi-messenger transients, the software requires additional modules,

h5py, mpi4py, corner, matplotlib, gwpy

and the samplers,

cpnest, dynesty, emcee, ultranest

All these packages can be easily installed via pip.

Installing this package

The bajes package is available on PyPI and the installation can be performed using pip as

pip install bajes

Alternatively, the source code can be found on GitHub and the package can be installed with setuptools routines,

python setup.py install
  • Note, it is possible that your system will require the sudo specification in order to build the package. If this is the case, this option will prevent setup.py from estimating the path to the project repository. Then, the installation can be performed using the flag -E,

     sudo -E python setup.py install
    

Once bajes is installed, it is possible to perform Bayesian inference on arbitrary models, see inf_tutorial.

The execution of the provided pipeline can be handled with a configuration file, see conifg_example. In order to execute the gravitational-wave pipeline routines, the user should install additional packages depending on the requested template: