Here you can put a brief description (approximately 2-3 sentence) of your time with the NASA Student Airborne Research Program (SARP). You might mention the year of your program or that you flew on a NASA aircraft. You could also mention which group you were in as well as your graduate or faculty mentors. All this text is optional, but it's a good way to orient someone that comes to your repository wondering what it is they are looking at. A one sentence plain language description of your project can also be a great benefit.
This is a great place to put your SARP presentation abstract.
This template was generated as an example for how to format and upload project code to github. Remember that uploading your code can be an interative process - it doesn't have to be perfect the first time! First focus on getting your code online, then move onto progressively organizing the code. Once you reach the cleaning stage some things to look for include:
- Make sure each chunk of code has a comment or markdown explanation of what is happening in the code
- Delete code that isn't ever used. It can be hard (emotionally), but it helps the code you are using be more useful.
- Break your project code into a few different notebooks by analysis step and name them starting with a number. For example:
01_preprocessing.ipynb
,02_timeseries_analysis.ipynb
and03_visualization.ipynb
. - Keep seperate folders for code and figures
To get even deeper into code cleaning, check out the Good Research Code Handbook.
Some notes:
- If you are using satellite images as part of your analysis they may be too large to upload to github. In that case simply upload your code.