Skip to content
Snippets Groups Projects
Commit bd37bb5f authored by dh00601's avatar dh00601
Browse files

updated readme

parent 07c6ef0d
No related branches found
No related tags found
No related merge requests found
...@@ -7,9 +7,11 @@ Test coverage: ...@@ -7,9 +7,11 @@ Test coverage:
Powered by: Powered by:
![![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/) ![![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
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 ![https://ri0005.pages.surrey.ac.uk/binary_c-python/](binary-c-python), which is aimed to provide a convenient and easy-to-use interface to the ![http://personal.ph.surrey.ac.uk/~ri0005/doc/binary_c/binary_c.html](binary_c) 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`:
......
[tool.black] [tool.black]
target-version = ['py36'] target-version = ['py36']
[tool.coverage] [tool.coverage]
#omit = #omit =
# test_*.py # test_*.py
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment