Documentation
User Guide¶
Note
Both SampleDB and this documentation are still a work in progress. If you come across any issues or want to request a feature, please let us know.
SampleDB
is a web-based electronic lab notebook with a focus on sample and measurement metadata.Features
Track the entire sample lifecycle
From sample creation to its location in long-term storage, SampleDB can help you track each step in the sample lifecycle. By documenting how a sample is created or processed, used for a measurement or a publication, you ensure that all information is readily available whenever you need it.
Model complex processes
The SampleDB schema system allows you to define exactly what metadata should be stored for each process, from a simple check box to Markdown-powered rich text and plotly charts.
You can either quickly define a simple schema using the graphical editor or write it in JSON syntax to have access to all schema features.
Learn more about schemas.
Find what you are looking for
By leveraging the schema system and PostgreSQL JSONB support, SampleDB lets you search the process-specific metadata of all your objects. When you need to find a sample created with a specific combination of parameters, you can use the advanced search system with support for type-specific search filters and logical operators, and SampleDB will automatically do any unit conversions for you.
Learn more about the search function.
Save Time with Automation
Instead of entering data manually, you can save time and avoid errors by using the SampleDB HTTP API to automatically enter all information, whenever it is available in a machine-readable format in log files or instrument control systems.
Learn more about the HTTP API.
Analyze Data with JupyterHub
With all metadata available in SampleDB, you can define Jupyter notebook templates that can then be used on a JupyterHub with the relevant metadata inserted as a notebook cell.
Learn more about JupyterHub support.
Export to Dataverse
If you are using Dataverse to share your research data, you can use SampleDB to export metadata directly into a new dataset in a Dataverse of your choice.
Learn more about Dataverse export.