Material for the 2021 ESWN Professional Development Workshop: Developing Free and Open Source Software with PyGMT
There will be a PyGMT and Git refresher during a webinar
preceding the workshop. You can run the PyGMT
tutorial in a live session using: 
This workshop will include lessons about developing open source software and collaborative activities. During the activities, participants will contribute to open source software and work on issues in the PyGMT repository.
GMT/PyGMT Leaders:
ESWN Leader:
When:
- Date: August 17 (optional), August 18 - 19, 2021
- Time: 20:00 - 24:00 UTC; Event Time Zone Converter
Where:
Online via Zoom/Slack
- Create GitHub account
- Join Slack workspace (invitation via email)
- Install text editor (e.g., Visual Studio Code, Sublime Text, Atom)
- Gain some familiarity with Git/PyGMT
- Attend optional refresher (August 17)
- Review Software Carpentry material
- Review 2020 Remote Online Sessions for Emerging Seismologists- Unit 8 PyGMT
- Setup local PyGMT development environment
- Follow setup instructions
- Attend help session (optional, August 17)
- Ask questions on Slack workspace
- Join the GMT community (optional)
- Register for an account on the GMT Forum
Please make sure you know the local time for the workshop sessions! Use the Event Time Zone Converter and compare UTC to your time zone.
Participants will receive zoom invitations via email.
| Theme | Duration | UTC Time |
|---|---|---|
| PyGMT refresher | 1 hr | 20:00-21:00 |
| Break | 15 min | 21:00 - 21:15 |
| Git refresher | 1 hr | 21:15 - 22:15 |
| Break | 15 min | 22:15 - 22:30 |
| Environment setup | 1.5 hr | 22:30 - 24:00 |
| Theme | Duration | UTC Time |
|---|---|---|
| Welcome | 20 min | 20:00 - 20:20 |
| Introduction to free, open source software | 30 min | 20:20 - 20:50 |
| Break | 10 min | 20:50 - 21:00 |
| First issues - making a pull request (GitHub workflow) | 50 min | 21:00 - 21:50 |
| Break | 10 min | 21:50 - 22:00 |
| Earth Science Women's Network Welcome | 10 min | 22:00 - 22:10 |
| First issues - making a pull request (local workflow) | 40 min | 22:10 - 22:50 |
| Break | 10 min | 22:50 - 23:00 |
| First issues - reviewing pull requests | 45 min | 23:00 - 23:45 |
| Wrap-up | 15 min | 23:45 - 24:00 |
| Theme | Duration | UTC Time |
|---|---|---|
| Writing unit tests | 20 min | 20:00 - 20:20 |
| Second issue - break-out group discussion | 15 min | 20:20 - 20:35 |
| Second issue - group reports | 15 min | 20:35 - 20:50 |
| Break | 10 min | 20:50 - 21:00 |
| Second issue - local development to work through issues/pull requests | 50 min | 21:00 - 21:50 |
| Break | 10 min | 21:50 - 22:00 |
| Second issue - incorporating suggestions from reviewers | 50 min | 22:00 - 22:50 |
| Break | 10 min | 22:50 - 23:00 |
| Second issue - continue working on contributions | 30 min | 23:00 - 23:30 |
| Maintaining software | 10 min | 23:30 - 23:40 |
| Resources for further learning | 5 min | 23:40 - 23:45 |
| Wrap-up | 15 min | 23:45 - 24:00 |
We will use the Slack workspace, the Zoom Chat window, and GitHub issues/pull requests to help you during the course:
- During a presentation, the other instructors will monitor the Slack workspace as well as the Chat room and answer any questions.
- During an activity, we will collaborate on Zoom and monitor the Slack workspace for questions. Feedback about contributions will happen through GitHub issues/pull requests.
All involved individuals must follow the PyGMT Code of Conduct. Act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. Any questions/concerns can be raised in private through direct messages on Slack to any of the workshop leaders.
This content is licensed under a
Creative Commons Attribution 4.0 International License.
