How to Cite QEM
===============

If you use QEM in your research, please cite it appropriately.

Citation Format
---------------

**Journal Articles:**

.. code-block:: text

   Zhang, Z. et al. (2024). QEM: A Python Package for Quantitative Electron 
   Microscopy Analysis. Journal of Open Source Software, X(XX), XXXX.
   https://doi.org/10.xxxxx/joss.xxxxx

**Preprint/ArXiv:**

.. code-block:: text

   Zhang, Z. et al. (2024). QEM: Quantitative Electron Microscopy Analysis 
   with Multi-Backend Deep Learning Support. arXiv preprint arXiv:XXXX.XXXX.

**Software Citation:**

.. code-block:: text

   Zhang, Z. et al. (2024). QEM - Quantitative Electron Microscopy (Version 0.1.0) 
   [Computer software]. https://github.com/zezhong-zhang/qem

BibTeX
------

For LaTeX users:

.. code-block:: bibtex

   @software{qem2024,
     title = {QEM - Quantitative Electron Microscopy},
     author = {Zhang, Zezhong and others},
     year = {2024},
     version = {0.1.0},
     url = {https://github.com/zezhong-zhang/qem},
     institution = {AI for Science Institute}
   }

EndNote
-------

For EndNote users:

.. code-block:: text

   %0 Computer Program
   %T QEM - Quantitative Electron Microscopy
   %A Zhang, Zezhong
   %D 2024
   %C Beijing, China
   %I AI for Science Institute
   %U https://github.com/zezhong-zhang/qem
   %V 0.1.0

Related Work
------------

If you use specific QEM features, please also consider citing:

**For the original StatSTEM method:**

.. code-block:: text

   De Backer, A. et al. (2013). StatSTEM: An efficient approach for accurate 
   and precise model-based quantification of atomic resolution electron 
   microscopy images. Ultramicroscopy, 131, 70-91.

**For Keras/deep learning aspects:**

.. code-block:: text

   Chollet, F. et al. (2015). Keras. https://keras.io

**For JAX backend (if used):**

.. code-block:: text

   Bradbury, J. et al. (2018). JAX: composable transformations of 
   Python+NumPy programs. http://github.com/google/jax

Acknowledgments
---------------

The developers would like to acknowledge the contributions from:

- The EMAT research group at University of Antwerp
- The open-source scientific Python community

Example Acknowledgment
----------------------

"The quantitative STEM analysis was performed using QEM (Zhang et al., 2024), 
a Python package for atomic-resolution electron microscopy analysis."

Questions
---------

For citation questions or to report QEM usage in publications:
zhangzz@aisi.ac.cn