FAQ¶
Under construction
This FAQ is being expanded. Suggest questions via a GitHub issue.
Do I need to install anything to use Nestling?
No. If you are here to read the lessons, this site is all you need. You only need to install Python and Git if you want to run the code examples locally. See Environment Setup if that applies to you.
My supervisor hasn't told me where to start. What do I do?
Start with How to Use This Repo, which has a short guide to choosing a track based on what you are working on right now. When you next meet your supervisor, ask them which track to prioritise; they know your project and can give you a more specific steer.
Something isn't working. What should I do?
Ask your supervisor first. They have almost certainly hit the same issue before. If you think there is an error in Nestling itself, open a GitHub issue.
Do I need to complete the tracks in order?
No. Each track is self-contained. Start with the one most relevant to your current work. The Getting Started guide can help you decide.
What Python version do I need?
Python 3.11 or later. See Environment Setup for installation instructions.
Can I use these materials in a course or workshop?
Yes. Nestling is licensed under GPL-3.0-or-later. You are free to use, adapt, and redistribute the materials provided you follow the licence terms and attribute the source.
I found an error. How do I report it?
Open an issue on the GitHub repository. Include the page, the error, and (if you know it) the correction.
How do I contribute a lesson?
See CONTRIBUTING.md in the repository root for the full contribution guide.