Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] - Write a user-guide on the pipeline #7

Open
jerdra opened this issue Jul 4, 2019 · 0 comments
Open

[DOCS] - Write a user-guide on the pipeline #7

jerdra opened this issue Jul 4, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jerdra
Copy link
Owner

jerdra commented Jul 4, 2019

Should write up some documentation on how to run and configure the pipeline to get things up and running. The following documentation is required for the main pipeline:

  1. nextflow configuration file paths (container locations etc... for singularity)
  2. required singularity containers (mri2mesh, rtms_bayesian, connectome workbench)
  3. input data specification (BIDS)
  4. output specification - where to find outputs, what does each output mean
  5. how to work with outputs (gmsh simulation and mesh files, surfaces)
  6. how to make custom weight functions on the surface (parcellation-based/FC-based/etc)

In addition documentation is needed for:

  1. tetrahedral projection (tetrapro) - the methods used
  2. geometry library (geolib) - description of each function and implementation
  3. surface patch extraction - how a sampling surface is defined
  4. objective function (FieldFunc) - reference documentation of methods and use
@jerdra jerdra added the documentation Improvements or additions to documentation label Jul 4, 2019
@jerdra jerdra changed the title Write a user-guide on the pipeline [DOCS] - Write a user-guide on the pipeline Dec 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant