Skip to content

Commit

Permalink
Add scientific details to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs committed Oct 27, 2023
1 parent 1165953 commit a79f337
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# <div align="center">datalab</div>
# <div align="center"><i>datalab</i></div>

<div align="center">
<a href="https://github.com/the-grey-group/datalab/actions/workflows/ci.yml">
Expand All @@ -18,8 +18,13 @@ src="https://img.shields.io/readthedocs/the-datalab?logo=readthedocs&color=bluev

<!-- datalab logo -->

This repository contains the code for a data management system that consists of
two main components:
This repository contains the code for the **datalab** data management system, targeted (broadly) at materials chemistry labs but with customisability and extensability in mind.

The main aim of **datalab** is to provide a platform for capturing the significant amounts of long-tail experimental data and metadata produced in a typical lab, and enable storage, filtering and future data re-use by humans and machines.
The platform provides researchers with a way to record sample- and cell-specific metadata, attach and sync raw data from instruments, and perform analysis and visualisation of many characterisation techniques in the browser (XRD, NMR, electrochemical cycling, TEM, TGA, Mass Spec, Raman).
Importantly, **datalab** stores a network of interconnected research objects in the lab, such that individual pieces of data are stored with the context needed to make them scientifically useful.

**datalab** consists of two main components:

- a Flask-based Python web server (`pydatalab`) that communicates with a MongoDB
database backend and can perform simple analysis and ETL of particular data types,
Expand Down Expand Up @@ -58,7 +63,7 @@ in the Department of Chemistry at the University of Cambridge.

## Development status

datalab remains under active development, and the API, data models and UI may change significantly between versions without prior notice.
**datalab** remains under active development, and the API, data models and UI may change significantly between versions without prior notice.
Where possible, and without breaking changes will be listed in the release notes for every pre-v1 release.

## Installation
Expand Down

0 comments on commit a79f337

Please sign in to comment.