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.2.2.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

cassini-0.2.2-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file cassini-0.2.2.tar.gz.

File metadata

  • Download URL: cassini-0.2.2.tar.gz
  • Upload date:
  • Size: 36.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for cassini-0.2.2.tar.gz
Algorithm Hash digest
SHA256 7a2afb9c3180d6680e1f89cfe3c8efda73eb0fb45f324e77563cf1defa349ad5
MD5 82ac367e2a218a5a8234abc1b23eb13c
BLAKE2b-256 8c9bd3124b56c6413a67defd0cd937a954d49577df418ee8c6367f28345e751c

See more details on using hashes here.

File details

Details for the file cassini-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: cassini-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for cassini-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 82f08888055f0bd5d79e211c35fd349bcb53fe9601bbf05d04baa4094bf744e4
MD5 d744d0f27979ebe5b5339d09e188c2a8
BLAKE2b-256 2186014b0daaaa32da1aa5fb1e6d859976df98a245ee5a62041834708fafe6ca

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