This is a brief abstract of my exemplar, which includes a representative image.
This exemplar was developed at Imperial College London by (YOUR NAME) in collaboration with (RSE MENTOR) from Research Software Engineering and (RCDS MENTOR) from Research Computing & Data Science at the Early Career Researcher Institute.
After completing this exemplar, students will:
- Learning Outcome 1
- Learning Outcome 2
- Learning Outcome 3
Who will benefit from studying this exemplar.
- Required skills/knowledge (e.g. programming languages, libraries, theory, courses)
- System requirements (e.g. Python 3.11+, Anaconda, 50 GB disk space, etc.)
- Hardware or HPC requirements (if any)
e.g. Step-by-step guide:
- Start by (instruction).
- Visit the sections of this notebook in some particular order.
- Attempt exercises
1a
,1b
, etc. - Progress to advanced materials in the Github repository linked here.
- Compare with solutions available in the
solutions
folder.
Briefly describe how this project fits in your discipline, why you chose to work on it, and what other disciplines may find it useful.
Programming language(s), libraries, and scientific software used.
Overview of code organisation and structure.
.
├── notebooks
│ ├── ex1.ipynb
├── src
│ ├── file1.py
│ ├── file2.cpp
│ ├── ...
│ └── data
├── docs
└── test
Code is organised into logical components:
notebooks
for tutorials and exercisessrc
for core code, potentially divided into further modulesdata
withinsrc
for datasetsdocs
for documentationtest
for testing scripts
- Data ingestion pipeline
- Tutorial with small data exercise
- Core analysis algorithms
- Documentation with worked example
- Basic visualisation tools
- Mini-project: "Create your first plot"
- Results export functionality
- Usage tutorial with export task
- Short video walkthrough (planned)
- Automated testing suite
- Debugging challenge
- Documentation for core methods
- Advanced statistical models
- Example notebook with exercises
- Interactive dashboard
- Exercise: Build a simple component
- Multi-format data import/export
- Guide with hands-on tasks
- Collaboration tools integration
- Exercise: Set up collaborative workflow
- Include diagram of workflow (optional)
- Extended visualisation options
- Creative task: Design a custom plot
List datasets used with:
- Licensing info
- Where they are included (in the repo or external links)
- Code testing and/or test examples
- Use of continuous integration (if any)
- Any other software development best practices
Task | Time |
---|---|
Reading | 3 hours |
Practising | 3 hours |
- Relevant sources, websites, images, AOB.
This project is licensed under the BSD-3-Clause license.