/win-fmrib-tutorial-2024

Practical session on using git for the MR graduate course 2024

Primary LanguagePythonOtherNOASSERTION

Welcome to the Open Science Ambassadors Repository - Graduate course tutorial 2024 - reboot camp

Authors: Open Science Ambassadors 2024

The following order of names does not denote priority or importance in the creation of the repository and course material:

  1. Anna Guttesen / she/her / FMRIB / @nnm329 / 0000-0003-0284-1578
  2. Lara Nikel / she/her / NDCN / @lara.nikel / 0000-
  3. Lilian Weber / she/her / Psychiatry / @lilweber / 0000-0001-9727-9623
  4. Ying-Qiu (Akina) Zheng / she/her / FMRIB / @yqzheng1 / 0000-0003-1236-0700
  5. Juju Fars / they/them / NDCN / @pfr545 / 0000-0001-7771-5029
  6. Bernd Taschler / he/him / BDI / @ndcn1032 / 0000-0001-6574-4789

Overview

This repository serves as a learning resource for individuals interested in gaining hands-on experience with Git, text editors, metadata, license files, and README files for online repositories. It is designed for educational purposes only.

Contents

  1. Fake Dataset: Contains a fabricated dataset for demonstration purposes.
  2. Dummy Code (Python): Includes sample Python code to showcase basic programming concepts.
  3. Fake Ethics File: Provides a simulated ethics file, demonstrating considerations for ethical data usage.
  4. Fake MR Protocol: Features a fictitious MR (Magnetic Resonance) protocol for educational reference.

Purpose

The primary objective of this repository is to facilitate learning in the following areas:

  • Utilizing Git for version control.
  • Understanding the importance of metadata in research and coding projects.
  • Familiarizing oneself with various text editors for code development.
  • Learning to include license files to define project permissions and restrictions.
  • Crafting informative README files to guide users and contributors.
  • Emphasizing the significance of code commenting for clarity and maintainability.

Usage

  1. Clone this repository to your local machine using Git.
  2. Explore the contents of each directory to understand their purpose.
  3. Experiment with modifying the code, dataset, and other files.
  4. Practice committing changes and pushing them to your remote repository.
  5. Learn to create metadata files, license files, and README files for your own projects.

Contributions

We welcome contributions from the community to enhance this educational resource. If you have suggestions for improvements or would like to add additional content, please feel free to submit a pull request.

License

CC BY-NC-SA 4.0 Deed Attribution-NonCommercial-ShareAlike 4.0 International

This license enables reusers to distribute, remix, adapt, and build upon the material in any medium or format for noncommercial purposes only, and only so long as attribution is given to the creator. If you remix, adapt, or build upon the material, you must license the modified material under identical terms. CC BY-NC-SA includes the following elements:

BY: credit must be given to the creator. NC: Only noncommercial uses of the work are permitted. SA: Adaptations must be shared under the same terms.

Note: Remember to respect intellectual property rights and ethical guidelines when using real datasets and protocols in your projects.

Happy learning!