diff --git a/README.md b/README.md index e2094f4ef8498608b6ea8d1c9836c181cc719d8d..e167e4c396d7f7460c410571defb89cc011d5093 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,11 @@ Test coverage: Powered by: ](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 , 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 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 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 -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: If you want to contribute to the code, then it is recommended that you install the packages in `development_requirements.txt`: diff --git a/pyproject.toml b/pyproject.toml index eda419d6b4f08d09ed3cdb6b8ebe95f2c4dd7e77..e12491148af538f4fb14dbeca767548362129a28 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,6 @@ [tool.black] target-version = ['py36'] - [tool.coverage] #omit = # test_*.py