Physiopy-documentation

[isesteves]

Title

Physiopy-documentation: Writing and organising documentation for physiological data handling

Leaders

Sarah Goodale (@s_goodale23)
Inês Esteves (@isesteves)

Collaborators

No response

Brainhack Global 2022 Event

Brainhack Physiopy

Project Description

Physiopy is a community formed around developing tools to operate physiological files in neuroimaging setups. This project specifically will expand our package documentation containing tips and strategies on how to collect and analyze various forms of physiological data and the use of our packages. Contributors may get started from any skill set and level, as this project will predominantly be focused on documentation contributions. Most of all, we are looking for people excited to learn (and contribute to) the best practices in physiological signal acquisition.

Link to project repository/sources

https://github.com/physiopy/physiopy.github.io

Goals for Brainhack Global

We aim to provide a succinct overview of what physiological data are typically recorded during an fMRI experiment, how these signals are recorded, and how these signals can improve our modeling of fMRI time series data. This is an active field of research, and we hope to encourage all users to get the latest recommendations prior to initiating a new study.

Good first issues

1. Improve the documentation for Physiopy’s packages
2. Build best practices libraries and summaries for various physiological signals (e.g., respiratory, cardiac, skin conductance, etc.)
3. Search for additional open source libraries and software similar to what we do
4. Find links to educational courses of interest
5. Enlarge our list of open source datasets with physiological signals
6. Improve the website’s interface

Communication channels

https://physiopy.slack.com/archives/C042U2KLF36

Skills

GitHub: basic
Markdown: basic to advanced
Physiological data acquisition/analysis: basic to advanced

Onboarding documentation

https://docs.github.com/en/get-started
https://www.markdownguide.org/

What will participants learn?

Participants will learn (at least) the basics about different types of physiological data acquired in neuroimaging setups and how they can be used. In addition, they will get acquainted with Github and Markdown, which may be helpful in other contexts.

Data to use

No response

Number of collaborators

more

Credit to collaborators

Project contributors are listed on our Team page.

Image

Type

documentation

Development status

1_basic structure

Topic

MR_methodologies, physiology

Tools

other

Programming language

documentation

Modalities

fMRI, MRI

Git skills

0_no_git_skills, 1_commit_push, 2_branches_PRs

Anything else?

No response

Things to do after the project is submitted and ready to review.

• Add a comment below the main post of your issue saying: Hi @brainhackorg/project-monitors my project is ready!
• Twitter-sized summary of your project pitch.

[smoia]

@Remi-Gau I don't know if we can do this, but this was also Brainhack Geneva - can we add both labels?

[Remi-Gau]

Done but I have NO idea if our website if smart enough to filter for more than one thing: to check.

And defo the jupyter book at the moment only consider that projects are specific to a single event (but I opened an issue for that).

[smoia]

Sounds good Remi, thank you!
In that case, if @isesteves agrees, @brainhackorg/project-monitors our project is ready!

[isesteves]

Yes, thank you both!

[Remi-Gau]

Apparently the filters on the project page are able to handle more than one site label perpeojwcr.