vlpp

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 10 Open GitHub ↗

Villeneuve Laboratory PET Pipeline

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Villeneuve Laboratory PET Pipeline (VLPP)

VLPP is an open-source software for analyzing PET images combined with freesurfer.

VLPP is builded with the [Nextflow framework][nextflow] which enables scalable and reproducible scientific workflows.

## Usage

`vlpp.nf --pet <> --freesurfer <> --participant <> [-c <>]`

###### Mandatories arguments:

- `--pet`: PET file (`mnc`, `nii` or `nii.gz`)
- `--freesurfer`: Freesurfer directory of the participant
- `--participant`: Participant ID

###### Optional arguments:

- `--help`: Print vlpp usage
- `-c, -config`: Add the specified file to configuration set
- `-resume`: Execute the script using the cached results, useful to continue executions that was stopped by an error
- `-h` or `-help`: Print the nextflow usage

## Configurations

Default Parameters and explanation: see `config/default.config`

## Using the pipeline on `guillimin`

Please follow this [link][guillimin-doc].

## Install

#### Software dependencies

- [matlab](https://www.mathworks.com/)
- [spm](http://www.fil.ion.ucl.ac.uk/spm/)
- [fsl](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/)
- [freesurfer](https://surfer.nmr.mgh.harvard.edu/)
- [ANTs](http://stnava.github.io/ANTs/)
- [minctools](http://www.bic.mni.mcgill.ca/ServicesSoftware/MINC)
- [Nextflow][nextflow]
- graphviz

#### Python dependencies with conda

If you use [conda](https://conda.io/docs/). Python dependencies, nextflow and graphviz will be installed automatically.

```
conda config --add channels conda-forge
conda config --add channels bioconda

git clone https://github.com/villeneuvelab/vlpp.git
cd vlpp

conda env create -f environment.yml -n vlpp
source activate vlpp

#Install vlpp in edit mode
pip install -e .
```

After that, you should add the `pipelines` and `scripts` directories to your `PATH`.

[dian]: https://www.nia.nih.gov/alzheimers/clinical-trials/dominantly-inherited-alzheimer-network-dian
[guillimin-doc]: https://github.com/villeneuvelab/documentation/wiki/VLPP-on-guillimin
[nextflow]: https://www.nextflow.io/
[pad]: http://www.douglas.qc.ca/page/prevent-alzheimer

vlpp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README