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 0.9.1, 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

Installation from source:

For this it is best to set up a virtual environment. Activate the virtualenvironment and enter the cloned version of the repo.

Then run:

python setup.py clean && python setup.py build --force && python setup.py sdist && pip install -v dist/binarycpython-<version of this package>.tar.gz
python setup.py clean && pip uninstall binarycpython && rm dist/* && python setup.py build --force && python setup.py sdist && pip install -v dist/binarycpython-<version of this package>.tar.gz

This will clean the build directory, remove binarycpython from the venv, remove the dist packages, and then rebuilding and reinstalling the package. You can find the version of this package in setup.py.

This will install this package into the virtual environment. Making changes to the sourcecode can be "installed" into the virtual env with the same command.

If this is not the first time you install the package, but rather rebuild it because you make changes in either binary_c or binarycpython, you should ignore the currently installed version, and also skip installing the dependencies again, by executing the following command:

python setup.py clean && pip uninstall binarycpython && rm dist/* && python setup.py build --force && python setup.py sdist && pip install --ignore-installed --no-dependencies -v dist/binarycpython-<version of this package>.tar.gz

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.