diff --git a/README.md b/README.md index c2d27fc9281a6e8edec4d243e3972f349cfd5c6c..31d0fa4188123b51e575c830550552765c76b342 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,5 @@ # Python module for binary_c -Docstring coverage: - -Test coverage: - - -Powered by: - +   We present our package [binary-c-python](https://ri0005.pages.surrey.ac.uk/binary_c-python/), a population synthesis code which is aimed to provide a convenient and easy-to-use interface to the [binary_c](http://personal.ph.surrey.ac.uk/~ri0005/doc/binary_c/binary_c.html) 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. @@ -103,6 +97,13 @@ from within the `commands/` directory ### Running unit tests There are two versions of the general unit tests. The first includes only the actual code of the project, and is located at `binarycpython/test/main.py`. The second includes the tutorial notebooks, and is located at `binarycpython/test/main_with_notebooks.py`. To run just the notebook tests run `python binarycpython/tests/test_notebooks.py` +### Pulling the JOSS paper article repo +We've written a JOSS paper for `binary_c-python`, which is stored in https://gitlab.com/dhendriks/paper_joss_binarycpython, but is also added as a submodule to this repository. To initialise and pull the repo as a submodule, run + +``` +git submodule update --init --recursive +``` + ## FAQ/Issues: Here we provide a non-exhaustive list of some issues we encountered and solutions for these: