Skip to content

docs: update getting started page #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 29, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion doc/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.amazon.com/Atomic-Pair-Distribution-Function-Analysis/dp/0198885806>`_.

Installation
------------

To install ``diffpy.cmi``, create a new conda environment and install the package from the conda-forge channel.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do I need a new environment or I could install it in an existing one if I wanted? I think most people get that, and we use this wording a lot, but it does worry me a bit that it will send a message that this needs to be installed in its own environment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sbillinge Added wording saying you can create a new env or activate and existing env


.. 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 <https://github.com/Billingegroup/pdfttp_data>`_.
Binary file added doc/source/img/pdfprimer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ Acknowledgements

``diffpy.cmi`` is built and maintained with `scikit-package <https://scikit-package.github.io/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 <https://doi.org/10.1107/S2053273315014473>`_


=================
Table of contents
=================
Expand Down
23 changes: 23 additions & 0 deletions news/getting-started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* Add getting started page to docs with link to primer book.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading