From 5e76153f56d7ab64353878f4ea2fa70573998824 Mon Sep 17 00:00:00 2001 From: Arthur McCray Date: Thu, 19 Mar 2026 09:07:51 -0700 Subject: [PATCH 1/2] Rename CONTRIBUTORS.md to CONTRIBUTING.md --- CONTRIBUTORS.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTORS.md => CONTRIBUTING.md (100%) diff --git a/CONTRIBUTORS.md b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTORS.md rename to CONTRIBUTING.md From 40a5f69e45da63e863158fb6650d0c3322121939 Mon Sep 17 00:00:00 2001 From: Arthur McCray Date: Thu, 19 Mar 2026 09:17:01 -0700 Subject: [PATCH 2/2] Adding citation section to README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f08b9ed0..8069481f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,16 @@ The package is available on the Python Package Index (PyPi), as [quantem](https: You can install it using `pip install quantem`. -For a developer install, please refer to [CONTRIBUTORS.md](CONTRIBUTORS.md). +For a developer install, please refer to [CONTRIBUTING.md](CONTRIBUTING.md). + +## Citing this work + +If you use the `quantem` package in your work, please cite our DOI: [temp link](https://zenodo.org/) + +Additionally, if you use any of the following modules, please cite the relevant paper(s): +- Diffractive imaging (direct ptychography): [Varnavides et al.](https://arxiv.org/abs/2507.18610) +- Diffractive imaging (iterative ptychography): [McCray et al.](https://arxiv.org/abs/2511.07795) +- Tomography: [Lim et al.](https://arxiv.org/abs/2512.08113) ## License