Binary population synthesis code that interfaces with binary_c. Based on a original work by Jeff Andrews. Updated and extended for Python3 by David Hendriks, Robert Izzard.
We present our package , which is aimed to provide a convenient and easy-to-use interface to the  framework, allowing the user to rapidly evolve single stellar systems and populations of star systems. Based on a early work by Jeff Andrews. Updated and extended for Python3 by David Hendriks, Robert Izzard.
The current release is version [version](VERSION), make sure to use that version number when installing!
binary_c-python is developed for students and scientists in the field of stellar astrophysics, who want to study the evolution single and binary star systems (see the example use-case notebooks in the [https://ri0005.pages.surrey.ac.uk/binary_c-python/example_notebooks.html](online documentation).
The current release is version [version](VERSION), and is designed and tested to work with binary_c version 2.2.1 (for older or newer versions we can't guarantee correct behaviour).
## Installation
## Installation
To install binary_c-python we need to make sure we meet the requirements of installation, and
To install binary_c-python we need to make sure we meet the requirements of installation, and
...
@@ -62,7 +64,7 @@ See the examples/ directory for example scripts and notebooks. The documentation
...
@@ -62,7 +64,7 @@ See the examples/ directory for example scripts and notebooks. The documentation
Make sure that with every change/recompilation you make in `binary_c`, you also rebuild this package. Whenever you change the sourcecode of this package, you need to reinstall it into your virtualenvironment as well
Make sure that with every change/recompilation you make in `binary_c`, you also rebuild this package. Whenever you change the sourcecode of this package, you need to reinstall it into your virtualenvironment as well
### Documentation
### Documentation
Look in the docs/ directory. Within the build/html/ there is the html version of the documentation. The
Look in the docs/ directory. Within the build/html/ there is the html version of the documentation. The documentation is also hosted on http://personal.ph.surrey.ac.uk/~ri0005/doc/binary_c/binary_c.html but only for the most recent stable release.
## Development:
## Development:
If you want to contribute to the code, then it is recommended that you install the packages in `development_requirements.txt`:
If you want to contribute to the code, then it is recommended that you install the packages in `development_requirements.txt`: