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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of the architecture and general principles #589

Open
robertoostenveld opened this issue Sep 3, 2022 · 0 comments
Open

Improve documentation of the architecture and general principles #589

robertoostenveld opened this issue Sep 3, 2022 · 0 comments

Comments

@robertoostenveld
Copy link
Member

On the train back from BIOMAG2022 in Birmingham, @schoffelen and I identified the following key features that we build on

  • cfg (ft_checkconfig, user-readable)
  • data structures (ft_checkdata, dimord, independent of file format, parsimonious)
  • difference between high-level and (private) low-level functions, synchronize-private
  • modular design of algorithms (specest, preproc, inverse, ...)
  • pre/postamble
  • inputfile/outputfile
  • consistent user feedback (ft_notification)
  • FT functions callling FT functions (rollback provenance)
  • GUI layout ft_uilayout
  • consistency in the reference documentation (i.e. help)

I have started on a http://fieldtriptoolbox.org/development/architecture page to improve the documentation of these principles and features.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@robertoostenveld