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

updated readme and ensembles notebook

parent 9937caa8
No related branches found
No related tags found
No related merge requests found
......@@ -55,9 +55,14 @@ We can also install the package from source, which is useful for development ver
This will install the package, along with all the dependencies, into the current active (virtual) python environment.
#### After installation
#### After installation from source
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.
### Use of code without installation
Because installing `binary_c-python` requires a working installation of `binary_c`, installing via pip or from source without this working installation of `binary_c` won't work. To still make use of some of the functions provided by `binary_c-python`, you can add the path to the code-base to your `PYTHONPATH`:
- Download `binary_c-python`, via e.g. `git clone https://gitlab.com/binary_c/binary_c-python.git`
- Add the path to the downloaded repo to your `$PYTHONPATH`, via e.g. `export PYTHONPATH="~/binary_c-python:$PYTHONPATH"`
## Usage
### Examples
See the examples/ directory for example scripts and notebooks. The documentation contains example pages as well.
......
%% Cell type:code id:d4799c94-afd8-41db-ab82-e0a6e278ed77 tags:
%% Cell type:markdown id:d1d00572-29aa-4f27-a59c-f9f05889da7d tags:
# Tutorial: Generating and handling ensemble data
TODO: coming soon!
%% Cell type:code id:e8d9fca3-dd16-4c2c-a180-14d9a6b533ed tags:
``` python
```
......
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