README.md

Python module for binary_c

Docstring coverage: Test coverage:

Binary population synthesis code that interfaces with binary_c. Based on a original work by Jeff Andrews (can be found in old_solution/ directory). Updated and extended for Python3 by David Hendriks, Robert Izzard.

The current release is version version, make sure to use that version number when installing!

Requirements

To run this code you need to at least have installations of:

• Python 3.6 or higher
• binary_c version 2.1.7 or higher

And the following python packages (which will get installed automatically when installing with pip):

• numpy
• pytest
• h5py
• pathos
• pandas
• astropy
• matplotlib
• py_rinterpolate

Environment variables

Before compilation you need to have certain environment variables:

Required:

• BINARY_C should point to the root directory of your binary_c installation
• LD_LIBRARY_PATH should include $BINARY_C/src and whatever directories are required to run binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)
• LIBRARY_PATH should include whatever directories are required to build binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)
• GSL_DIR should point to the root location where you installed GSL to. This root dir should contain bin/, lib/ etc

Build instructions

First, make sure you have built binary_c (See $BINARY_C/doc/binary_c2.pdf section: installation for all the installation instructions for binary_c)) and that it functions correctly.

Installation via PIP:

To install this package via pip:

pip install binarycpython

This will install the latest stable installation that is available on pip.

Installation from source:

We can also install the package from source, which is useful for development versions and when you want to modify the code. It is recommended that you install this into a virtual environment. From within the root directory, run

./install.sh

This will install the package, along with all the dependencies.

If this is not the first time you install the package, but rather rebuild it because you made changes in either binary_c or binarycpython, you can run

./install_without_dependencies.sh

to reinstall just binarycpython.

After installation

After installing the code via source it is useful to run the test suite before doing any programming with it. The test suite is stored in binarycpython/tests and running python main.py in there will run all the tests.

Examples

See the examples/ directory for example scripts and notebooks. The documentation contains example pages as well.