nano-crucible

The official Python client library and command-line interface for Crucible, the Molecular Foundry's scientific data management platform for experimental and computational research.

Using the hosted service requires a Crucible account and API key.

Capabilities

• Create, search, update, and download scientific datasets through Python or the CLI
• Attach uploaded or externally stored files and manage ingestion requests
• Capture structured fields, flexible scientific metadata, and searchable keywords
• Track samples and parent-child provenance relationships
• Organize resources into projects and manage access

Install

pip install nano-crucible

Install optional parser dependencies when working with supported scientific formats:

pip install "nano-crucible[parsers]"

Get started

Configure credentials and verify connectivity:

crucible config init
crucible status

The same configured credentials are available to the Python client:

from crucible import CrucibleClient

client = CrucibleClient()
for dataset in client.datasets.list(limit=5):
    print(dataset["unique_id"], dataset.get("dataset_name"))

Continue with the installation and configuration guide or the quick start.

Documentation

• Core concepts
• User guide
• CLI overview and reference
• Python API reference
• Changelog and migration notes

Contributing

See the contribution guide for development setup, testing, and documentation conventions.

Support and license

Ask questions on Discord or open a GitHub issue. nano-crucible is distributed under the BSD 3-Clause License.

nano-crucible is developed and maintained by the Data Group at the Molecular Foundry, Lawrence Berkeley National Laboratory.