diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index 374b8b7..3571c5c 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -8,4 +8,31 @@ Getting started ================ -Coming soon... +.. image:: ./img/pdfprimer.png + :alt: codecov-in-pr-comment + :width: 150px + :align: right + +For detailed instructions and in-depth examples of modeling with ``diffpy.cmi``, we highly recommend the book, + +*Atomic Pair Distribution Function Analysis: A Primer* by Simon J. L. Billinge and Kirsten M. Ø. Jensen (Oxford University Press, 2023). + +To purchase this book, please visit `this link `_. + +Installation +------------ + +To install ``diffpy.cmi``, create a new conda environment or activate an existing environment and install the package from the conda-forge channel. + +.. code-block:: console + + conda create -n diffpy.cmi-env + conda install -c conda-forge diffpy.cmi + conda activate diffpy.cmi-env + + +Data and Examples +----------------- + +Worked examples and experimental data from the book are freely available at our +`GitHub repository `_. diff --git a/doc/source/img/pdfprimer.png b/doc/source/img/pdfprimer.png new file mode 100644 index 0000000..0833dc7 Binary files /dev/null and b/doc/source/img/pdfprimer.png differ diff --git a/doc/source/index.rst b/doc/source/index.rst index e8faac3..c102948 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -43,6 +43,18 @@ Acknowledgements ``diffpy.cmi`` is built and maintained with `scikit-package `_. +======== +Citation +======== + +If you use ``diffpy.cmi`` in a scientific publication, we would like you to cite this package as + + Juhás, P.; Farrow, C. L.; Yang, X.; Knox, K. R.; Billinge, S. J. L. + Complex Modeling: A Strategy and Software Program for Combining Multiple Information Sources to Solve Ill Posed Structure and Nanostructure Inverse Problems. + *Acta Crystallogr A Found Adv* **2015**, *71* (6), 562–568. + `https://doi.org/10.1107/S2053273315014473 `_ + + ================= Table of contents ================= diff --git a/news/getting-started.rst b/news/getting-started.rst new file mode 100644 index 0000000..25f3c6e --- /dev/null +++ b/news/getting-started.rst @@ -0,0 +1,23 @@ +**Added:** + +* Add getting started page to docs with link to primer book. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*