-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Milestone
Description
What?
- Write a tutorial notebook on the use of the ioSPI/micrographs.py module.
- Add details in the docstrings of the micrographs.py module.
- Add corresponding unit-tests.
- Use pre-commit (see README) to make sure that your code follows style guidelines.
Optionally:
- If needed, modify the micrographs.py module to improve user experience.
Why?
Micrographs are arguably the most important type data of raw cryo-EM data.
Being able to manipulate micrographs easily is pivotal to enter the field, and take an active part in cryo-EM research.
Where?
- The notebook should go in the notebooks folder with the title
micrographs.ipynb. - The test of the notebook should go in a new file
test_notebooks.pyin the tests folder, inspired by this file.
How?
Get inspiration on how to write your notebook, look at:
- other notebooks, e.g. here.
- the test file for the micrographs.py module
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Todo