Skip to content

Commit

Permalink
Attempt at addressing #58 checkbox 2 and/or 3
Browse files Browse the repository at this point in the history
  • Loading branch information
layik committed Feb 2, 2023
1 parent 949b310 commit 00847a1
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,31 +57,15 @@ The following dependencies place additional requirements on the environment wher
- `db`: to support the database interface (currently just [psycopg2](https://www.psycopg.org/docs/)). **Requires an installation of PostgreSQL**.


#### Running the tutorial notebooks

The Bokeh plots produced by setvis require the package `notebook >= 6.4` to display properly.

Installing the `notebook` extra dependency set (see above) will include everything
required to run setvis in a notebook, and to run the tutorial examples
that do not need a database connection. For the latter, install `db`
as well.

If the installation succeeded, it should be possible to run the
notebooks in the `notebooks` directory of the repository:

```
python -m jupyter notebook
```

### Conda

These instructions have been tested with:
- [Miniconda3](https://docs.conda.io/en/latest/miniconda.html) (based on Conda 4.10.3) with Python 3.8 on Windows 10 Pro 20H2

```posh
# Create an activate a conda environment
conda create -n paceenv python=3.8
conda activate paceenv
conda create -n setvisenv python=3.8
conda activate setvisenv
# This is unnecessary if git is already installed
conda install git
Expand Down Expand Up @@ -117,6 +101,26 @@ poetry install
poetry shell
```

#### Tutorials

For basic examples, please see the two example notebooks:
- [Missingness example](https://github.com/alan-turing-institute/setvis/blob/main/notebooks/Example%20-%20import%20data%20to%20visualize%20missingness.ipynb)
- [Set example](https://github.com/alan-turing-institute/setvis/blob/main/notebooks/Example%20-%20import%20data%20to%20visualize%20sets.ipynb)

The Bokeh plots produced by setvis require the package `notebook >= 6.4` to display properly.

Installing the `notebook` extra dependency set (see above) will include everything
required to run setvis in a notebook, and to run the tutorial examples
that do not need a database connection. The repository includes GitHub actions script which executres
all of the notebooks in the `notebooks` directory.

If the installation succeeded, it should be possible to run the
notebooks in the `notebooks` directory of the repository:

```
python -m jupyter notebook
```

## Acknowledgements

The development of the setvis software was supported by funding from the Engineering and Physical Sciences Research Council (EP/N013980/1; EP/K503836/1) and the Alan Turing Institute.

0 comments on commit 00847a1

Please sign in to comment.