Workflows used for morphology processing.
Project description
Morphology Workflows
This project contains several workflows for processing morphologies:
- Curate: from raw morphologies, ensures that morphologies can be used with the rest of
BBP codes
- Annotate: create various annotations on morphologies needed by specific BBP codes
- Repair: process morphologies to correct for artifacts of in-vitro reconstruction
In a nutshell, the user provides a list of morphologies in a .csv file, with their names and
paths and a luigi.cfg configuration file. Each workflow is run independently and creates an
output folder, with one subfolder per task. In each, there will be a report.csv and a data
folder containing the output files of the task if any. In the report.csv file, columns contain
paths to these files, additional information, error messages if the task failed on that
morphologies, as well as a flag is_valid, used in subsequent tasks to filter valid morphologies.
At the end of each workflow, another report.csv file is created, with the main output columns of
each tasks, and a report.pdf containing a human readable summary of the result of the workflow.
Installation
This should be installed using pip:
pip install morphology-workflows
Usage
This workflow is based on the luigi library but can be run via the command line interface:
morphology_workflows --local-scheduler Curate
NOTE This command must be executed from a directory containing a
luigi.cfgfile. An example of such file is given in theexamplesdirectory.
More details can be found in the command line interface section of the documentation.
Examples
The examples folder contains a simple example that will process a set of morphologies.
A dataset.csv file is provided which is taken as input for the workflows. A luigi.cfg file
is also provided to give a default configuration for the workflows.
This example can simply be run using the following command:
./run_curation.sh
This script will create a new directory out_curated which will contain the report and all the
results.
Funding & Acknowledgment
The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.
For license and authors, see LICENSE.txt and AUTHORS.md respectively.
Copyright © 2021 Blue Brain Project/EPFL
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file morphology-workflows-0.2.0.tar.gz.
File metadata
- Download URL: morphology-workflows-0.2.0.tar.gz
- Upload date:
- Size: 1.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f970c518c9974aa979fda95348b4f57e55c16611f6955e983d6ee473c36187de |
|
| MD5 | 5db4f9afd7c402db0abdac9ffaea9404 |
|
| BLAKE2b-256 | 69f57d2f491629f4dbfe00d0538c08988aae84d3902c40dd785b2b8c8efa18c9 |
