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

updated readme

parent 14721aa2
No related branches found
No related tags found
No related merge requests found
......@@ -6,7 +6,7 @@ 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.
The current release is version 0.9.1, make sure to use that version number when installing!
The current release is version [version](VERSION), make sure to use that version number when installing!
## Requirements
To run this code you need to at least have installations of:
......@@ -44,22 +44,20 @@ To install this package via pip:
```
pip install binarycpython
```
This will install the latest stable installation that is available on pip.
### Installation from source:
For this it is best to set up a virtual environment. Activate the virtualenvironment and enter the cloned version of the repo.
Then run:
We can also install the package from source, which is useful for development versions and when you want to modify the code. It is recommended that you install this into a virtual environment. From within the root directory, run
```
python setup.py clean && pip uninstall binarycpython && python setup.py build --force && python setup.py sdist && pip install -v dist/binarycpython-<version of this package>.tar.gz
./install.sh
```
This will clean the build directory, remove binarycpython from the venv, remove the dist packages, and then rebuilding and reinstalling the package. You can find the version of this package in setup.py.
This will install this package into the virtual environment. Making changes to the sourcecode can be "installed" into the virtual env with the same command.
This will install the package, along with all the dependencies.
If this is not the first time you install the package, but rather rebuild it because you make changes in either binary_c or binarycpython, you should ignore the currently installed version, and also skip installing the dependencies again, by executing the following command:
If this is not the first time you install the package, but rather rebuild it because you made changes in either binary_c or binarycpython, you can run
```
python setup.py clean && pip uninstall binarycpython && python setup.py build --force && python setup.py sdist && pip install --ignore-installed --no-dependencies -v dist/binarycpython-<version of this package>.tar.gz
./install_without_dependencies.sh
```
to reinstall just binarycpython.
#### 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.
......
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