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

Uploaded Source

Built Distribution

cassini-0.3.0a0-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cassini-0.3.0a0.tar.gz
  • Upload date:
  • Size: 44.9 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.0a0.tar.gz
Algorithm Hash digest
SHA256 dedb751063da8faa5044f902c6a0c67f8fcfc99e5ffd1fb312dcb10904a7acdf
MD5 ae6f662844fef8028d4a7170499a7749
BLAKE2b-256 eb60c9d78f744e062691fc70f0c3816205ebf8321604d759119f1beb95b70312

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cassini-0.3.0a0-py3-none-any.whl
  • Upload date:
  • Size: 52.7 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.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 061598561db60b49af67500817017d2f73a99f944efdbbd4cf0794387dbdf550
MD5 24f8598e8f8098d47299dc1e2884ad5e
BLAKE2b-256 a7f6c3832c8dcb16e7d08ab191a89af823aea50d116f9243e781fab6752e7f67

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