brainglobe / brainglobe/brainglobe.github.io

[Feature] An in-depth "explanation" of our considerations, assumptions and choices in template builder

Open
#491 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
14
Forks
32
Avg merge
1d 22m
Merged PRs (30d)
9

Description

**Is your feature request related to a problem? Please describe.**
We are working on a HowTo guide (in the diataxis sense) in #457 to cover our template building pipeline.

**Describe the solution you'd like**
An "explanation" in the [diataxis sense](https://diataxis.fr/explanation/) to help people gain in-depth context around our template builder pipelines and how they fit into the wider ecosystem.

They should include (among other things) the "why"-questions raised by @PolarBean in https://github.com/brainglobe/brainglobe.github.io/pull/465

* [two questions about masking](https://github.com/brainglobe/brainglobe.github.io/pull/465/changes#r3250065295)
* in particular how what the masking parameters mean, and approaches to adapting them
* [some design choices about preprocessing](https://github.com/brainglobe/brainglobe.github.io/pull/465/changes#r3250115632)
* [reasoning behind padding volumes](https://github.com/brainglobe/brainglobe.github.io/pull/465/changes#r3250100903)
* [reasoning behind copying txt files manually to their own folders](https://github.com/brainglobe/brainglobe.github.io/pull/465/changes/BASE..ab9f52d424a28898d398629980d01f615d637845#r3260005130)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.