Skip to content

feat: doi in readme, new group standard format #180

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 1 commit into from
May 2, 2025
Merged
Show file tree
Hide file tree
Changes from all 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
14 changes: 6 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,15 @@ which is the most common geometry for lab PDF measurements.

The theory is described in the following paper:

An Absorption Correction for Reliable
Pair-Distribution Functions from Low Energy x-ray Sources,
Yucong Chen, Till Schertenleib, Andrew Yang, Pascal Schouwink,
Wendy L. Queen and Simon J. L. Billinge, in preparation.
Chen, Y., Schertenleib, T., Yang, A., Schouwink, P., Queen, W.L. and Billinge, S.J.L.,
An Absorption Correction for Reliable Pair-Distribution Functions from Low Energy x-ray Sources.
Arxiv.org. https://doi.org/10.48550/arXiv.2504.12499

The related experimental data acquisition protocols are described in the following paper:

Testing Protocols for Obtaining Reliable PDFs from Laboratory
x-ray Sources Using PDFgetX3,
Till Schertenleib, Daniel Schmuckler, Yucong Chen, Geng Bang Jin,
Wendy L. Queen and Simon J. L. Billinge, in preparation.
Schertenleib, T., Schmuckler, D., Chen, Y., Jin, G.B., Queen, W.L. and Billinge, S.J.L. (2025),
Testing Protocols for Obtaining Reliable Pair Distribution Functions from Laboratory X-Ray Sources Using PDFgetX3.
Chem. Methods 2500001. https://doi.org/10.1002/cmtd.202500001

For more information about the diffpy.labpdfproc library, please consult our `online documentation <https://diffpy.github.io/diffpy.labpdfproc>`_.

Expand Down
6 changes: 3 additions & 3 deletions doc/source/examples/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Examples
Landing page for diffpy.labpdfproc examples.

.. toctree::
labpdfprocapp_example
functions_example
tools_example
labpdfprocapp-example
functions-example
tools-example
6 changes: 3 additions & 3 deletions doc/source/utilities/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ Check the :ref:`examples<Examples>` provided for how to use these.
.. contents::
:depth: 2

.. include:: labpdfprocapp_utility.rst
.. include:: functions_utility.rst
.. include:: tools_utility.rst
.. include:: labpdfprocapp-utility.rst
.. include:: functions-utility.rst
.. include:: tools-utility.rst
23 changes: 23 additions & 0 deletions news/folder-rst-readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* doi in Readme for papers.

**Changed:**

* hyphens / underscores format according to new scikit-package group standard.

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading