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.0a5.tar.gz (46.3 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cassini-0.3.0a5.tar.gz
Algorithm Hash digest
SHA256 735be56a2cc076aac93f51ffd0f7e38135091e911bbe8cad96214ec5a7198017
MD5 4e73dce5ca4ac0b57dcb6f2eeaa355fb
BLAKE2b-256 6745f9d65d8bfe80dd6f42351dae98273d9750a0d6bd04f3c123851a83ffdfee

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cassini-0.3.0a5-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.19

File hashes

Hashes for cassini-0.3.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 c2ea605eb3f3bd557a7ebf8b1021432cfdc7901075f743f6f130677caefcdf50
MD5 079c0cd539d28b83bf75571cefcf4a20
BLAKE2b-256 bceeb4b7b7e8f480c443dd4908c05909dec07cde53d175d513a7e8882fdd33b9

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