# Welcome to AFMReader

AFMReader is a [Python](https://www.python.org) package for loading Atomic Force Microscopy (AFM) image files and
metadata. It is primarily used by the [TopoStats](https://AFM-SPM.github.io/TopoStats) package for loading AFM images
for processing. Both AFMReader and packages are written and maintained by members of the [Pyne
Lab](https://pyne-lab.uk/bio/) based at the [University of Sheffield](https://sheffield.ac.uk).

- [Introduction](introduction.md)
- [Installation](installation.md)
- [Usage](usage.md)
- [Contributing](contributing.md)
- [Workflow](workflow.md)
- [Links](links.md)
- [API](api/index.md)

## Citing

If you use or depend on AFMReader in your software please consider citing it in any derivative work that is
published. Citation details can be found in the
[CITATION.cff](https://github.com/AFM-SPM/AFMReader/blob/main/CITATION.cff) file in the source repository.

Please email us at [topostats@sheffield.ac.uk](mailto:topostats@sheffield.ac.uk) with details of your package us if you
use AFMReader in your software.