
Write one central function or class.Įxample: we’re working on a package that plots the most likely galactic orbits for a user-specified subset of the Gaia catalog. Here’s a more detailed suggested timeline:ĭay 1: decide on the purpose of the package. Writing docs/tests/packaging will keep you busy on Days 3 and 4. Days 1 and 2 are the main time to develop the core functionality of your package. You should aim to spend 10 hours (2.5 hours per day) working on the project. We should be able to import your package and call it.Įach of these goals will be covered on a different day of the workshop, so it’s completely fine if you don’t know how to do each of these right now. be pip installable and runnable on other computers.contain unit tests and end-to-end tests.be thoroughly documented using docstrings.Project Goal:ĭevelop an open-source Python package for astronomy from the ground up. On the final day of the workshop (Saturday June 25th), you’ll (optionally) have a chance to present your package to the other Code/Astro participants. This is an opportunity to put the knowledge you’ve learned from Code/Astro intro practice. If you already have group partners in mind, please email us! If not, we will assign you to a group based on timezone, career level, and any personal preferences you've communicated to us. Throughout this week, you’ll be working with a small group of collaborators (1-4 others) on a final project, a real open-source Python package for astronomy.


Workshop "cheatsheet" of links & information: Getting Startedīefore the workshop, please complete the following:įollow the installation instructions to get the necessary packages installed.ĭo the diagnostic assignment to get familiarized with some Python fundamentals. Course materials for the 2021 Code/Astro workshop.
