/SharingGuidelines

A quick reminder on how to write and share pipelines, comments, software testing

SharingGuidelines

A quick reminder on how to write and share pipelines, comments, software testing

Outline for Markdown Guide files: (overall in all the text, bold is used for few words highlighting, and italics for personal comments)

Title of Pipeline

[Authors: contact reference]

In Brief:

Intro

Main advantages of this Pipeline

Inputs

Outputs


How this "new software" works (everything that is done in the black box) as a continuation of why using this pipeline and software compared to others


Atlases used by software


Docs

Example1

(this section is papers, extra details, anything to refer to...)


Output Folders Structure:

Software1


Full Pipeline Outline

  1. a -> b -> c
  2. a -> b -> c
  3. a
  4. a

Pipeline in detail


Part1

1a) Software-A

(as last point in each section/ part, also a paragraph on "Most common problems and how to fix them" should be included)