16
16
:target: https://github.com/psf/black
17
17
18
18
.. |CI | image :: https://github.com/diffpy/diffpy.srmise/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
19
- :target: https://github.com/diffpy/diffpy.srmise/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
19
+ :target: https://github.com/diffpy/diffpy.srmise/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
20
20
21
21
.. |Codecov | image :: https://codecov.io/gh/diffpy/diffpy.srmise/branch/main/graph/badge.svg
22
22
:target: https://codecov.io/gh/diffpy/diffpy.srmise
@@ -72,14 +72,18 @@ must be specified.
72
72
73
73
For more information about the diffpy.srmise library, please consult our `online documentation <https://diffpy.github.io/diffpy.srmise >`_.
74
74
75
+
75
76
Citation
76
77
--------
77
78
78
- If you use diffpy.srmise in a scientific publication, we would like you to cite this package as
79
+ If you use this program for a scientific research that leads
80
+ to publication, we ask that you acknowledge use of the program
81
+ by citing the following paper in your publication:
79
82
80
- L. Granlund, Billinge, S. J. L., and P. M. Duxbury. “Algorithm for systematic peak extraction from atomic
81
- pair distribution functions”. In: Acta Crystallogr. A 71.4 (2015), pp. 392–409. DOI:
82
- 10.1107/S2053273315005276
83
+ L. Granlund, S. J. L. Billinge and P. M. Duxbury,
84
+ `Algorithm for systematic peak extraction from atomic pair distribution functions
85
+ <http://dx.doi.org/10.1107/S2053273315005276> `__,
86
+ *Acta Crystallogr. A * **4 **, 392-409 (2015).
83
87
84
88
Installation
85
89
------------
@@ -104,11 +108,7 @@ Then, to fully install ``diffpy.srmise`` in our active environment, run ::
104
108
105
109
Another option is to use ``pip `` to download and install the latest release from
106
110
`Python Package Index <https://pypi.python.org >`_.
107
- To install using ``pip `` into your ``diffpy.srmise_env `` environment, we will also have to install dependencies ::
108
-
109
- pip install -r https://raw.githubusercontent.com/diffpy/diffpy.srmise/main/requirements/run.txt
110
-
111
- and then install the package ::
111
+ To install using ``pip `` into your ``diffpy.srmise_env `` environment, type ::
112
112
113
113
pip install diffpy.srmise
114
114
0 commit comments