Skip to content

Commit 1465a33

Browse files
committed
docs: update getting started page with link to book and installation instructions
1 parent f1ce2cd commit 1465a33

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

doc/source/getting-started.rst

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,31 @@
88
Getting started
99
================
1010

11-
Coming soon...
11+
.. image:: ./img/pdfprimer.png
12+
:alt: codecov-in-pr-comment
13+
:width: 150px
14+
:align: right
15+
16+
For detailed instructions and in-depth examples of modeling with ``diffpy.cmi``, we highly recommend the book,
17+
18+
*Atomic Pair Distribution Function Analysis: A Primer* by Simon J. L. Billinge and Kirsten M. Ø. Jensen (Oxford University Press, 2023).
19+
20+
To purchase this book, please visit `this link <https://www.amazon.com/Atomic-Pair-Distribution-Function-Analysis/dp/0198885806>`_.
21+
22+
Installation
23+
------------
24+
25+
To install ``diffpy.cmi``, create a new conda environment and install the package from the conda-forge channel.
26+
27+
.. code-block:: console
28+
29+
conda create -n diffpy.cmi-env
30+
conda install -c conda-forge diffpy.cmi
31+
conda activate diffpy.cmi-env
32+
33+
34+
Data and Examples
35+
-----------------
36+
37+
Worked examples and experimental data from the book are freely available at our
38+
`GitHub repository <https://github.com/Billingegroup/pdfttp_data>`_.

0 commit comments

Comments
 (0)