From 48f2ad8d184df3bd08e498d754c7812e6590c662 Mon Sep 17 00:00:00 2001 From: David Hendriks <davidhendriks93@gmail.com> Date: Mon, 26 Jul 2021 10:15:52 +0100 Subject: [PATCH] updated readme w.r.t tests --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 45a539dab..3acb8596d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ 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 +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.4, make sure to use that version number when installing! ## Requirements To run this code you need to at least have installations of: @@ -59,6 +61,9 @@ If this is not the first time you install the package, but rather rebuild it bec python setup.py clean && 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. -- GitLab