From a44e8371e899c777577df02d025803019a687b24 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Sun, 6 Oct 2024 10:38:24 -0400 Subject: [PATCH] Fix citation format for conda-forge recipe windows build (#132) * Use cookiecutter and fix citation * Fix citation to diffpy.structure format --- LICENSE.rst | 8 ++++---- README.rst | 20 ++++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/LICENSE.rst b/LICENSE.rst index 7c8f8d0..3675628 100644 --- a/LICENSE.rst +++ b/LICENSE.rst @@ -8,10 +8,10 @@ If you use this program to do productive scientific research that leads to publication, we ask that you acknowledge use of the program by citing the following paper in your publication: - L. Granlund, S.J.L. Billinge, P.M. Duxbury, Algorithm for - systematic peak extraction from atomic pair distribution - functions, Acta Crystallographica A 71(4), 392-409 (2015). - doi:10.1107/S2053273315005276 + L. Granlund, S. J. L. Billinge and P. M. Duxbury, + `Algorithm for systematic peak extraction from atomic pair distribution functions + `__, + *Acta Crystallogr. A* **4**, 392-409 (2015). For more information please visit the diffpy web-page at http://www.diffpy.org diff --git a/README.rst b/README.rst index 5072fea..b86c784 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,7 @@ :target: https://github.com/psf/black .. |CI| image:: https://github.com/diffpy/diffpy.srmise/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg - :target: https://github.com/diffpy/diffpy.srmise/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg + :target: https://github.com/diffpy/diffpy.srmise/actions/workflows/matrix-and-codecov-on-merge-to-main.yml .. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.srmise/branch/main/graph/badge.svg :target: https://codecov.io/gh/diffpy/diffpy.srmise @@ -72,14 +72,18 @@ must be specified. For more information about the diffpy.srmise library, please consult our `online documentation `_. + Citation -------- -If you use diffpy.srmise in a scientific publication, we would like you to cite this package as +If you use this program for a scientific research that leads +to publication, we ask that you acknowledge use of the program +by citing the following paper in your publication: - L. Granlund, Billinge, S. J. L., and P. M. Duxbury. “Algorithm for systematic peak extraction from atomic - pair distribution functions”. In: Acta Crystallogr. A 71.4 (2015), pp. 392–409. DOI: - 10.1107/S2053273315005276 + L. Granlund, S. J. L. Billinge and P. M. Duxbury, + `Algorithm for systematic peak extraction from atomic pair distribution functions + `__, + *Acta Crystallogr. A* **4**, 392-409 (2015). Installation ------------ @@ -104,11 +108,7 @@ Then, to fully install ``diffpy.srmise`` in our active environment, run :: Another option is to use ``pip`` to download and install the latest release from `Python Package Index `_. -To install using ``pip`` into your ``diffpy.srmise_env`` environment, we will also have to install dependencies :: - - pip install -r https://raw.githubusercontent.com/diffpy/diffpy.srmise/main/requirements/run.txt - -and then install the package :: +To install using ``pip`` into your ``diffpy.srmise_env`` environment, type :: pip install diffpy.srmise