diff --git a/README.md b/README.md index e74c3ad205b35d8c495a01934eecf54c8b3dc964..df749f52da7bd0627e929ba9c7071ee9ba362a2b 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,34 @@ # platy-browser-tables -## Generating new version of segmentations and attributes +Data and data-generation for the [platybrowser](https://github.com/embl-cba/fiji-plugin-platyBrowser). -## Semantic versioning +## Data storage -[semantic versioning](https://semver.org/) +Image data (only links for the image volumes) and derived data for all versions are stored in the folder `data`. +We follow a versioning scheme inspired by [semantic versioning](https://semver.org/), hence all version +numbers are given as `MAJOR.MINOR.PATCH`. +- `PATCH` is increased if the derived data is update, e.g. due to corrections in some segmentation or new attributes in some table. This is usually triggered automatically (see section below). +- `MINOR` is increased if new derived data is added, e.g. a new segmentation for some structure or a new attribute table. This needs to be done manually. +- `MAJOR` is increased if new image / raw data is added, e.g. a new animal registered to the atlas or new genes. This needs to be done manually. + +For a given version `X.Y.Z`, the data is stored in the directory `/data/X.Y.Z/` with subfolders: + +- `images`: Raw image or gene expression data. Contains bigdata-viewer xml files with absolute links to h5 files on the embl server. +- `misc`: Miscellanous data. +- `segmentations`: Segmentation volumes derived from the image data. Only xml files. +- `tables`: CSV tables with attributes derived from image data and segmentations. + + +## Data generation + +In addition to the data, the scripts for generating the derived data are also collected here. +`scripts/segmentation` contains the scripts to generate the derived segmentations with automated segmentation approaches. +The other derived data can be generated for new segmentation versions with the script `update_platy_browser.py`; +`make_initial_version.py` was used to generate the initial data in `/data/0.0.0`. + + +## Installation + +TODO