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

Uploaded Source

Built Distribution

cassini-0.3.0a15-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cassini-0.3.0a15.tar.gz
  • Upload date:
  • Size: 46.8 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.0a15.tar.gz
Algorithm Hash digest
SHA256 0d9bf0f0843eb93a50c099233d05fe4c80b792cdb245463f4c2eb4fa5f3e25b3
MD5 8e6f4f566c3f4bd15e6f6d51b1caa7ed
BLAKE2b-256 a269472269db94810be361a0a99901a3c6b8c979b1366fc75b24a68352bb4787

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cassini-0.3.0a15-py3-none-any.whl
  • Upload date:
  • Size: 55.2 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.0a15-py3-none-any.whl
Algorithm Hash digest
SHA256 41fb2f4f6f84c8125f353a2b347df2bbb9bbab274d9ec7f7a5624ad135e6f796
MD5 3d8cda2c6624f50c6ca21b56fd87a704
BLAKE2b-256 9a839038a6b8636c50237a9db78a923fc3a06a64f2fad02ff4b1e22315d700fe

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