cassini

Cassini

Note Cassini is in it's alpha development stage, so things may not work perfectly - tell us about problems so we can fix them!

An electronic laboratory notebook (ELN), built inside Jupyter Lab.

Cassini's goal is to help you explore, analyse and organise your data in an environment that's familiar.

Features

• Structures your project into an easy to navigate hierarchy of workpackages, experiments, samples and datasets.
• Allows retrieval of data by name e.g. project['WP3.2f-XRD'] / 'XRD_data.csv.
• Create new sample, experiment (etc.) notebooks through custom dialogs.
• Create notebook templates for standardised proceedures.
• Browse and explore your project through a custom browser, including previewing cell outputs, such as plots in-browser.
• No magic! Everything is stored in regular human navigatable folders, cloud backups etc. work as expected.

Check out the demo binder for a walkthrough of features (note this can take a little while to load):

Installation and Setup

> pip install cassini

Create a project.py:

# project.py
from cassini import Project, DEFAULT_TIERS
from cassini import jlgui

project = Project(DEFAULT_TIERS, __file__)
jlgui.extend_project(project)

if __name__ == '__main__':
    project.launch()

And launch it:

> python project.py

Head to Quickstart for more info.

Contributing

Contributing guidelines are found here.

This includes development installation instructions and codebase orientation.