Skip to content

Welcome to Cassini's documentation!

Cassini enhances Python and JupyterLab by providing tools to help you manage and explore your data in a research project.

Features:

  • Structure your project into a logical hierarchy - no more lost data!
  • Retreive any data from anywhere, by name - no more copy and pasting data here there and everywhere!
  • Navigate and explore your project through a fast, specialised browser - no more endless clicking through folders!
  • Preview summaries of experiment parameters and results, including graphs, temperatures, volumes, weights - no more waiting around for notebooks to launch!
  • Define reusable templates for proceedures and analysis - no more copy and pasting code snippets!

Quickstart

If you have a bit more time, we recommend you check out the Tutorial.

Otherwise...

Installation

pip install cassini

Setup

In the directory you want your project to live, create your cas_project.py:

# cas_project.py
from cassini import Project, DEFAULT_TIERS

project = Project(hierarchy=DEFAULT_TIERS, project_folder=__file__)  # (1)!

if __name__ == '__main__': # (2)!
    project.launch() # (3)!
  1. Define your Cassini project object with the default hierarchy of WorkPackages, Experiments, Samples and DataSets, which lives in this directory.
  2. Only run this block when this file is ran as a script by itself.
  3. Launch this project instance, which launches JupyterLab, with this project configured.

Launch your new project from the command line:

python cas_project.py

This will setup Cassini and launch Jupyter Lab, with your new project configured.

In Jupyter Lab, open the launcher, scroll to the Cassini section and open the browser.

browser button

Create your first WorkPackage by clicking the little plus ( ) button in the empty table.

What Next

A walkthrough of Cassini's features can be found here:

- Note these binder notebooks can take a while to launch, so maybe click then go grab a cup off tea/ coffee!

Don't want to wait/ prefer reading? - head to the Tutorial.

Next