tee-ar-ex / tee-ar-ex/trx-python

Community file-format technological survey discussion

Open
#1 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
26
Forks
20
Avg merge
1d 14h
Merged PRs (30d)
9

Description

General goals

  • Uniformization across tools
  • Allowing features needed by the fields (from trk, tck or new one)
  • Conceptually simpler (Simplicity)
  • Less memory AND hard drive hungry
  • General robustness
  • Load/save efficiency/speed
  • Independence/standalone
  • Extensibility

What is 'supported' by the memmap implementation?

  • Agreement on the coordinates system (RASMM) [x]
  • Random-access support with minimal upfront IO [x]
  • Support data streaming and on-the-fly saving [x]
  • Minimalistic header [x]
  • Ability to store (sparse) groups [x]
  • Ability to store None, one or more additional metadata [x]
  • Self-explanatory [x]
  • Self-coherent / strict checks [-] (depends on the implementation)
  • Compression [-] (only zip_deflate)
  • GPU compatibility [-] (Array+offsets are compatible 'enough' with VTK/OpenGL)
  • “Easy” to implement with basic libraries (in C++, python, matlab, etc.) [x]
  • Parallel-friendly for saving (per process on-the-fly saving) [ ] (Not investigated, likely depends on implementation)

(Initial thread: https://github.com/nipy/nibabel/issues/942)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the initial thread in nibabel issue #942 and the memmap implementation referenced in this discussion. Identify which file-format goals are already supported and which remain unresolved. The work is complete when the community agrees on the survey findings and a concrete direction for the format.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.