Skip to main content

A tool to structure experimental work, data and analysis using Jupyter Lab.

Project description

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.

Screenshot

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):

Binder

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cassini-0.3.0a12.tar.gz (46.4 kB view details)

Uploaded Source

Built Distribution

cassini-0.3.0a12-py3-none-any.whl (54.8 kB view details)

Uploaded Python 3

File details

Details for the file cassini-0.3.0a12.tar.gz.

File metadata

  • Download URL: cassini-0.3.0a12.tar.gz
  • Upload date:
  • Size: 46.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for cassini-0.3.0a12.tar.gz
Algorithm Hash digest
SHA256 b0bcc58c9484002235dcc616640bfe87752f45bd5e15246814d150d745048e5c
MD5 9b71e4ffe17fe4870bc1aab655836ec8
BLAKE2b-256 e0be5fc8f5309a5f74408bb7c382cb777985fec4104aa3833727fe5863fbb2f7

See more details on using hashes here.

File details

Details for the file cassini-0.3.0a12-py3-none-any.whl.

File metadata

  • Download URL: cassini-0.3.0a12-py3-none-any.whl
  • Upload date:
  • Size: 54.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for cassini-0.3.0a12-py3-none-any.whl
Algorithm Hash digest
SHA256 1228988af9eab285148357e80e0e9d3f54c6336077c29f0b795e2fb0b64a336d
MD5 2539ec397751ea5327424ad14c1c6763
BLAKE2b-256 935b4b29ed1767c5d5f5e932544d01747988736cbbfa492e2188f5d906cb9c4b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page