File tree Expand file tree Collapse file tree 1 file changed +28
-1
lines changed Expand file tree Collapse file tree 1 file changed +28
-1
lines changed Original file line number Diff line number Diff line change 8
8
Getting started
9
9
================
10
10
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 >`_.
You can’t perform that action at this time.
0 commit comments