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

Sphinx Gallery Site #27

Open
JohnGriffiths opened this issue Oct 15, 2021 · 4 comments
Open

Sphinx Gallery Site #27

JohnGriffiths opened this issue Oct 15, 2021 · 4 comments

Comments

@JohnGriffiths
Copy link
Contributor

No description provided.

@JohnGriffiths
Copy link
Contributor Author

JohnGriffiths commented Oct 15, 2021

Pages we want to have:

These will become pages = .py scripts in examples folder (see below)

  • General commentary page
  • Data fetchers - PO
  • Snirf events - JG, DM
  • Snirf epoching - JG, DM
  • Snirf glm - JG, DM
  • Nifti events - AC, JG
  • Nifti volumetric glm - AC, JG
  • Nifti volumetric FC - AC, JG
  • Nifti surface glm - HA, JG
  • Nifti surface FC - HA, JG
  • EEG rest power spectra - TM
  • EEG epoched - KK
  • Homer surface projection and viz
  • Homer surface GLM
  • Homer surface FC
  • Montage things - JG
  • Homer pipeline script -
  • Custom psychopy task - TM
  • Data quality summary

Approach:

  1. Review relevant colab code
  2. Make a sketch outline of the example page contents. ( Major sections, analyses done, images shown)
  3. Decide what the functions should be and write them
  4. Make the script work
  5. Start running on github CI

@JohnGriffiths
Copy link
Contributor Author

Sphinx gallery example repos (there are many)

https://github.com/nilearn/nilearn
https://github.com/mne-tools/mne-python
https://github.com/NeuroTechX/eeg-notebooks

Four main folders in a CI- integrated sphinx gallery site hosting github repo:

  • library folder - contains core functions
  • doc folder - organized and manages website compilation and structure
  • examples folder - core executable scripts that make core example pages
  • hidden .github folder - defined github CI processes

The files corresponding to the executable

@tmorshed
Copy link
Member

tmorshed commented Oct 15, 2021

Colab notebook: https://drive.google.com/file/d/1wC1qsYH5jVRjuqASL5JgSzVB43_iDQbq/view?usp=sharing

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

No branches or pull requests

2 participants