From c31182a8f551eabfe9d03a8a1c4cd35d5eac3bfc Mon Sep 17 00:00:00 2001
From: dh00601 <dh00601@surrey.ac.uk>
Date: Fri, 17 Jun 2022 23:46:13 +0100
Subject: [PATCH] updated readme and ensembles notebook
---
README.md | 7 ++++++-
examples/notebook_ensembles.ipynb | 11 ++++++++++-
2 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 19d077101..5ea18c056 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 44ef8a7ef..cc9a3ad9f 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": []
--
GitLab