PlasmaPy Workshop at MagNetUS 2023
Thursday, June 15, 2023 from 2–5 pm CDT
Mell Classroom Building 3546
Auburn University, Auburn, Alabama, USA
We will be holding a workshop on the last day of the MagNetUS 2023 meeting.
Please use this form to sign up for the workshop.
The topics to be covered include:
- Getting started with PlasmaPy (open notebook in Colab)
astropy.units
plasmapy.particles
plasmapy.formulary
- How to contribute to an open source project
- Using
git
and GitHub - The code contribution workflow
- Documenting a function
- Testing a function
Preliminaries
Before the tutorial, please:
- Sign up for a free GitHub account
- Add a new SSH key to your GitHub account
- Verify that
git
is installed by opening a terminal and runninggit --version
If running Windows, please make sure you have access to a terminal (i.e., by installing Windows Subsystem for Linux).
Optionally, you may also configure git
with commands like:
git config --global user.name "Your Name" git config --global user.email "your.email@openmetadatastandards.com"