Tutorials¶
The setvis repository includes some tutorials and extended examples in the form of Jupyter notebooks. The tutorials are designed to introduce setvis concepts and be run interactively.
This section describes how to install and run these.
The source for all notebooks can be found within the setvis GitHub repository.
Install and run the notebooks¶
To access the tutorials, after setting up a suitable python environment (see the relevant section of the installation instructions), clone and install setvis from GitHub source.
git clone https://github.com/alan-turing-institute/visualising-data-profiles
cd visualising-data-profiles
Then run the command below to install the notebook extra dependency
set, which will include everything required to run setvis in a notebook,
and to run the tutorial examples that do not need a database
connection.
pip install ".[notebook]"
To be able to run the postgres examples, install the db extra
dependency set as well (see Extras and fine-tuning the
installation).
If the installation succeeded, it should be possible to run the
notebooks in the notebooks directory of the repository:
cd notebooks
python -m jupyter notebook
Warning
The Bokeh plots produced by setvis require the package notebook
with version >= 6.4 in order to display properly. If setvis is
installed as described above, this will be included automatically.
If using a ‘minimal’ setvis installation alongside an existing
notebook installation, please ensure that this requirement is met.