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

👽️ Update GUI to match nested config for C-PAC ≥ v1.8.0 (Phase 1) #76

Merged
merged 68 commits into from
Jul 30, 2021

Conversation

shnizzedy
Copy link
Member

@shnizzedy shnizzedy commented Apr 19, 2021

Fixes

Related to #66 by @shnizzedy
Should resolve most to all of the recent @dependabot PRs (#77, #80, #81, #82, #83, #84, #85, #86, #87, #88, #89, #90, #91, #92, #93, #94)

Description

  • autogenerates GUI from config YAML
    • boolean
    • text
    • number
    • dict
    • list
  • GUI editable
    • boolean
    • text
    • number
    • dict
    • list
      • of strings
      • of booleans
      • of numbers
  • loads config directly from YAML instead of redefining config
  • parses YAML 1.1 syntax (e.g., On == true)
  • save config to YAML for download
  • upload 1.8 configs
  • automatically updates when FCP-INDI/C-PAC:dev/docker_data/default_pipeline.yml changes
  • save and revert buttons work hidden
  • help tooltips correct hidden

Technical details

  • automatically updates from FCP-INDI/C-PAC:dev/docker_data/default_pipeline.yml and automatically converts to React for the GUI based on each entry's datatype in the YAML file except for nuisance regressors, because those currently have more specific handling and validation in the GUI than in C-PAC itself.
  • all changes are immediate.
  • default pipelines cannot be changed.
  • tab sequence is currently setup, anatomical preproc, functional preproc, surface, «unsorted» to match the sequence on the cards screenshot of cards Any top-level with a run switch that isn't anatomical preproc, functional preproc, or surface is counted in the # derivatives
  • includes a new custom 404 page
    404 screenshot

Unresolved (to do)

Tests

Run the GUI locally (yarn run dev:browser) and click around, make sure things behave as expected.

Screenshots

new-GUI-clickthrough.mov

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I updated the changelog.
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@shnizzedy
Copy link
Member Author

Nuisance regressors need some special handling. 🤞 Hopefully that's all that's left here.

@shnizzedy shnizzedy changed the title 🚧 WIP: 👽️ Update GUI to match nested config for C-PAC ≥ v1.8.0 (Phase 1) 👽️ Update GUI to match nested config for C-PAC ≥ v1.8.0 (Phase 1) Jul 21, 2021
@shnizzedy shnizzedy marked this pull request as ready for review July 21, 2021 18:09
@sgiavasis
Copy link
Collaborator

WHEW! Incredible 👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants