diff --git a/README.md b/README.md index 19d077101dbd1bcaf28c651b8689a999740f8908..5ea18c0561f34bbf3eb977991137b31545b98ae8 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/examples/notebook_ensembles.ipynb b/examples/notebook_ensembles.ipynb index 44ef8a7efb3dcf7514c47a6275629fd4c0464c8c..cc9a3ad9f4cfc1efc4c1327878f01b87bad9e8e5 100644 --- a/examples/notebook_ensembles.ipynb +++ b/examples/notebook_ensembles.ipynb @@ -1,9 +1,18 @@ { "cells": [ + { + "cell_type": "markdown", + "id": "d1d00572-29aa-4f27-a59c-f9f05889da7d", + "metadata": {}, + "source": [ + "# Tutorial: Generating and handling ensemble data\n", + "TODO: coming soon!" + ] + }, { "cell_type": "code", "execution_count": null, - "id": "d4799c94-afd8-41db-ab82-e0a6e278ed77", + "id": "e8d9fca3-dd16-4c2c-a180-14d9a6b533ed", "metadata": {}, "outputs": [], "source": []