diff --git a/README.rst b/README.rst index b50d20a..358c54d 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. diff --git a/doc/source/examples/examples.rst b/doc/source/examples/examples.rst index a1faeb5..4684a21 100644 --- a/doc/source/examples/examples.rst +++ b/doc/source/examples/examples.rst @@ -7,6 +7,6 @@ Examples Landing page for diffpy.labpdfproc examples. .. toctree:: - labpdfprocapp_example - functions_example - tools_example + labpdfprocapp-example + functions-example + tools-example diff --git a/doc/source/examples/functions_example.rst b/doc/source/examples/functions-example.rst similarity index 100% rename from doc/source/examples/functions_example.rst rename to doc/source/examples/functions-example.rst diff --git a/doc/source/examples/labpdfprocapp_example.rst b/doc/source/examples/labpdfprocapp-example.rst similarity index 100% rename from doc/source/examples/labpdfprocapp_example.rst rename to doc/source/examples/labpdfprocapp-example.rst diff --git a/doc/source/examples/tools_example.rst b/doc/source/examples/tools-example.rst similarity index 100% rename from doc/source/examples/tools_example.rst rename to doc/source/examples/tools-example.rst diff --git a/doc/source/utilities/functions_utility.rst b/doc/source/utilities/functions-utility.rst similarity index 100% rename from doc/source/utilities/functions_utility.rst rename to doc/source/utilities/functions-utility.rst diff --git a/doc/source/utilities/labpdfprocapp_utility.rst b/doc/source/utilities/labpdfprocapp-utility.rst similarity index 100% rename from doc/source/utilities/labpdfprocapp_utility.rst rename to doc/source/utilities/labpdfprocapp-utility.rst diff --git a/doc/source/utilities/tools_utility.rst b/doc/source/utilities/tools-utility.rst similarity index 100% rename from doc/source/utilities/tools_utility.rst rename to doc/source/utilities/tools-utility.rst diff --git a/doc/source/utilities/utilities.rst b/doc/source/utilities/utilities.rst index fc75d11..cd3a1d2 100644 --- a/doc/source/utilities/utilities.rst +++ b/doc/source/utilities/utilities.rst @@ -10,6 +10,6 @@ Check the :ref:`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 diff --git a/news/folder-rst-readme.rst b/news/folder-rst-readme.rst new file mode 100644 index 0000000..24d8f13 --- /dev/null +++ b/news/folder-rst-readme.rst @@ -0,0 +1,23 @@ +**Added:** + +* doi in Readme for papers. + +**Changed:** + +* hyphens / underscores format according to new scikit-package group standard. + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*