How to Use This Repo¶

Nestling is organised into three parts:

• Tracks: the main learning content. Each is a short, self-contained sequence of lessons on one skill.
• Examples: runnable notebooks and scripts in the examples/ folder of the repository.
• Templates: ready-to-adapt starting points for papers, slides, and other research documents.

Choosing a track¶

Your supervisor will usually point you to a specific track to begin with. If they haven't yet, ask. They know what is most relevant to your project right now.

As a rough guide:

• Asked to find and read papers? → ArXiv & Reading Papers
• Preparing a journal club presentation? → Journal Club
• Writing up results or a report? → Writing Papers
• Joining a project that uses code? → Git & GitHub
• Writing research code for the first time? → Coding Practices
• Producing figures for a report or paper? → Plotting
• Using AI assistants in your work? → Working with LLMs
• New to the group, or want to understand community standards? → Code of Conduct

You do not need to finish a track before it becomes useful. Work through what is relevant now and come back when you need the rest.

Running examples¶

Some tracks include runnable code examples. To run these locally you will need Python set up on your machine. See Environment Setup.

If you are only reading the lessons, you do not need to install anything. This site is all you need.

Using templates¶

Templates are in the Templates section. Each template comes with notes on how to adapt it. Your supervisor can advise on which template fits your current task.