Skip to content

Commit 9cfafba

Browse files
authoredAug 20, 2024
rst file changes (#171)
* Use the original license * other file changes * add a bit more in readme
1 parent fccca8a commit 9cfafba

File tree

3 files changed

+105
-106
lines changed

3 files changed

+105
-106
lines changed
 

‎AUTHORS.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ This code was developed as part of the DiffPy project to create python
1515
modules for structure investigations from diffraction data. The main
1616
contributors to this package were
1717

18-
Chris Farrow
19-
Jiwu Liu
20-
Pavol Juhas
18+
Chris Farrow,
19+
Jiwu Liu,
20+
Pavol Juhas,
2121
Dmitriy Bryndin
2222

2323
Other current and former contributors of the DiffPy project include
2424

25-
Simon Billinge
26-
Chris Farrow
27-
Emil Bozin
28-
Wenduo Zhou
25+
Simon Billinge,
26+
Chris Farrow,
27+
Emil Bozin,
28+
Wenduo Zhou,
2929
Peng Tian
3030

3131
The DiffPy team is part of the Billinge Group at Columbia University in New York,

‎LICENSE.rst

+67-63
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,80 @@
1-
Copyright (c) 2024, The Trustees of Columbia University
2-
in the City of New York.
3-
All rights reserved.
1+
.. code-block:: text
42
5-
This software was originally developed by the Billinge group as part
6-
of the Distributed Data Analysis of Neutron Scattering Experiments
7-
(DANSE) project funded by the US National Science Foundation under
8-
grant DMR-0520547. Developments of PDFfit2 were funded by NSF grant
9-
DMR-0304391 in the Billinge group, and with support from Michigan State
10-
University and Columbia University. Any opinions, findings, and conclusions
11-
or recommendations expressed in this material are those of the author(s)
12-
and do not necessarily reflect the views of the respective funding bodies.
13-
Subsequent development was done in the Billinge group at Columbia University
14-
and then in collaboration between the Billinge group at Columbia and Pavol
15-
Juhas at Brookhaven National Laboratory. Moving forward, PDFgui will be
16-
maintained as a community project with contributions welcomed from many people.
3+
This software was originally developed by the Billinge group as part
4+
of the Distributed Data Analysis of Neutron Scattering Experiments
5+
(DANSE) project funded by the US National Science Foundation under
6+
grant DMR-0520547. Developments of PDFfit2 were funded by NSF grant
7+
DMR-0304391 in the Billinge group, and with support from Michigan State
8+
University and Columbia University. Any opinions, findings, and conclusions
9+
or recommendations expressed in this material are those of the author(s)
10+
and do not necessarily reflect the views of the respective funding bodies.
11+
Subsequent development was done in the Billinge group at Columbia University
12+
and then in collaboration between the Billinge group at Columbia and Pavol
13+
Juhas at Brookhaven National Laboratory. Moving forward, PDFgui will be
14+
maintained as a community project with contributions welcomed from many people.
1715
18-
If you use this program to do productive scientific research that leads
19-
to publication, we ask that you acknowledge use of the program by citing
20-
the following paper in your publication:
16+
If you use this program to do productive scientific research that leads
17+
to publication, we ask that you acknowledge use of the program by citing
18+
the following paper in your publication:
2119
22-
C. L. Farrow, P. Juhas, J. W. Liu, D. Bryndin, E. S. Bozin,
23-
J. Bloch, Th. Proffen and S. J. L. Billinge, PDFfit2 and
24-
PDFgui: computer programs for studying nanostructure in
25-
crystals, J. Phys.: Condens. Matter 19, 335219 (2007)
20+
C. L. Farrow, P. Juhas, J. W. Liu, D. Bryndin, E. S. Bozin,
21+
J. Bloch, Th. Proffen and S. J. L. Billinge, PDFfit2 and
22+
PDFgui: computer programs for studying nanostructure in
23+
crystals, J. Phys.: Condens. Matter 19, 335219 (2007)
2624
27-
Up to the release 1.1.2 (February 2017) the copyright was held by
28-
the institutions that hosted the work as follows:
29-
Copyright 2006-2007, Board of Trustees of Michigan State University,
30-
Copyright 2008-2012, Board of Trustees of Columbia University in the
31-
city of New York.
32-
Copyright 2013, Brookhaven National Laboratory (Copyright holder
33-
indicated in each source file).
25+
Up to the release 1.1.2 (February 2017) the copyright was held by
26+
the institutions that hosted the work as follows:
27+
Copyright 2006-2007, Board of Trustees of Michigan State University,
28+
Copyright 2008-2012, Board of Trustees of Columbia University in the
29+
city of New York.
30+
Copyright 2013, Brookhaven National Laboratory (Copyright holder
31+
indicated in each source file).
3432
35-
As of February 2017, and the 1.1.2 release, PDFgui has moved to a shared copyright model.
33+
As of February 2017, and the 1.1.2 release, PDFgui has moved to a shared copyright model.
3634
37-
PDFgui uses a shared copyright model. Each contributor maintains copyright over their
38-
contributions to PDFgui. But, it is important to note that these contributions are
39-
typically only changes to the repositories. Thus, the PDFgui source code, in its entirety,
40-
is not the copyright of any single person or institution. Instead, it is the collective
41-
copyright of the entire PDFgui Development Team. If individual contributors want to
42-
maintain a record of what changes/contributions they have specific copyright on, they
43-
should indicate their copyright in the commit message of the change, when they commit
44-
the change to one of the PDFgui repositories.
35+
PDFgui uses a shared copyright model. Each contributor maintains copyright over their
36+
contributions to PDFgui. But, it is important to note that these contributions are
37+
typically only changes to the repositories. Thus, the PDFgui source code, in its entirety,
38+
is not the copyright of any single person or institution. Instead, it is the collective
39+
copyright of the entire PDFgui Development Team. If individual contributors want to
40+
maintain a record of what changes/contributions they have specific copyright on, they
41+
should indicate their copyright in the commit message of the change, when they commit
42+
the change to one of the PDFgui repositories.
4543
46-
The PDFgui Development Team is the set of all contributors to the PDFgui project.
47-
A full list can be obtained from the git version control logs.
44+
The PDFgui Development Team is the set of all contributors to the PDFgui project.
45+
A full list can be obtained from the git version control logs.
4846
49-
For more information please visit the project web-page:
50-
https://www.diffpy.org
51-
or email Prof. Simon Billinge at sb2896@columbia.edu
47+
For more information please visit the project web-page:
48+
https://www.diffpy.org
49+
or email Prof. Simon Billinge at sb2896@columbia.edu
5250
53-
Redistribution and use in source and binary forms, with or without
54-
modification, are permitted provided that the following conditions are met:
51+
Redistribution and use in source and binary forms, with or without
52+
modification, are permitted provided that the following conditions
53+
are met:
5554
56-
1. Redistributions of source code must retain the above copyright notice, this
57-
list of conditions and the following disclaimer.
55+
* Redistributions of source code must retain the above copyright
56+
notice, this list of conditions and the following disclaimer.
5857
59-
2. Redistributions in binary form must reproduce the above copyright notice,
60-
this list of conditions and the following disclaimer in the documentation
61-
and/or other materials provided with the distribution.
58+
* Redistributions in binary form must reproduce the above copyright
59+
notice, this list of conditions and the following disclaimer in the
60+
documentation and/or other materials provided with the distribution.
6261
63-
3. Neither the name of the copyright holder nor the names of its contributors
64-
may be used to endorse or promote products derived from this software
65-
without specific prior written permission.
62+
* Neither the name of the copyright holder nor the names of its
63+
contributors may be used to endorse or promote products derived from
64+
this software without specific prior written permission.
6665
67-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
68-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
69-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
70-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
71-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
72-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
73-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
74-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
75-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
76-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66+
THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER "AS IS". COPYRIGHT HOLDER
67+
EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EITHER
68+
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
69+
WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS, ADEQUACY OR SUITABILITY
70+
FOR A PARTICULAR PURPOSE, AND ANY WARRANTIES OF FREEDOM FROM
71+
INFRINGEMENT OF ANY DOMESTIC OR FOREIGN PATENT, COPYRIGHTS, TRADE
72+
SECRETS OR OTHER PROPRIETARY RIGHTS OF ANY PARTY. IN NO EVENT SHALL
73+
COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR ANY DIRECT, INDIRECT,
74+
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
75+
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
76+
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
77+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
78+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
79+
THIS SOFTWARE OR RELATING TO THIS AGREEMENT, EVEN IF ADVISED OF THE
80+
POSSIBILITY OF SUCH DAMAGE.

‎README.rst

+31-36
Original file line numberDiff line numberDiff line change
@@ -35,45 +35,34 @@
3535
.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
3636
:target: https://github.com/diffpy/diffpy.pdfgui/issues
3737

38-
diffpy.pdfgui
39-
========================================================================
40-
4138
Graphical user interface program for structure refinements to atomic
4239
pair distribution function.
4340

41+
For users who do not have the expertise or necessity for command
42+
line analysis, PDFgui is a convenient and easy to use graphical front
43+
end for the PDFfit2 refinement program. It is capable of full-profile
44+
fitting of the atomic pair distribution function (PDF) derived from x-ray
45+
or neutron diffraction data and comes with built in graphical and structure
46+
visualization capabilities.
47+
4448
PDFgui is a friendly interface to the PDFfit2 refinement engine, with many
4549
powerful extensions. To get started, please open the manual from the
46-
help menu and follow the tutorial instructions. A detailed description
47-
is available in the doc/Farrow-jpcm-2007.pdf paper.
48-
49-
50-
Requirements
51-
------------------------------------------------------------------------
52-
53-
PDFgui requires Python 3.8+ or 2.7 and several third-party
54-
libraries that are used by PDFgui and its components.
50+
help menu and follow the tutorial instructions. A detailed description
51+
is available in `this paper <http://dx.doi.org/10.1088/0953-8984/19/33/335219>`_.
5552

56-
* setuptools - tools for installing Python packages
57-
* wxpython - graphical user interface toolkit for Python
58-
* numpy - library for scientific computing with Python
59-
* matplotlib - Python 2D plotting library
60-
* diffpy.pdffit2 - computational engine for PDFgui,
61-
https://github.com/diffpy/diffpy.pdffit2
62-
* diffpy.structure - simple storage and manipulation of atomic
63-
structures, https://github.com/diffpy/diffpy.structure
64-
* diffpy.utils - shared helper utilities for wx GUI,
65-
https://github.com/diffpy/diffpy.utils
53+
For more information about diffpy.pdfgui, please consult our
54+
`online documentation <https://diffpy.github.io/diffpy.pdfgui>`_.
6655

67-
We recommend to use `Anaconda Python <https://www.anaconda.com/download>`_
68-
which allows to conveniently install PDFgui and all its software
69-
dependencies with a single command.
56+
Citation
57+
--------
7058

71-
Please note that the Python3 PDFgui will read .ddp3 files. It is also
72-
possible for it to read .ddp files that were saved by the Python2 PDFgui
73-
but it will sometimes fail to read these. We are working on a solution
74-
that will be available in a future version.
59+
If you use diffpy.pdfgui in a scientific publication, we would like you to
60+
cite this package as
7561

76-
diffpy.pdfgui Package, https://github.com/diffpy/diffpy.pdfgui
62+
C L Farrow, P Juhas, J W Liu, D Bryndin, E S Božin,
63+
J Bloch, Th Proffen and S J L Billinge, PDFfit2 and PDFgui:
64+
computer programs for studying nanostructure in crystals, J. Phys.:
65+
Condens. Matter 19 (2007) 335219. doi:10.1088/0953-8984/19/33/335219
7766

7867
Installation
7968
------------
@@ -98,7 +87,8 @@ Then, to fully install ``diffpy.pdfgui`` in our active environment, run ::
9887

9988
Another option is to use ``pip`` to download and install the latest release from
10089
`Python Package Index <https://pypi.python.org>`_.
101-
To install using ``pip`` into your ``diffpy.pdfgui_env`` environment, we will also have to install dependencies ::
90+
To install using ``pip`` into your ``diffpy.pdfgui_env`` environment, we will also have to
91+
install dependencies ::
10292

10393
pip install -r https://raw.githubusercontent.com/diffpy/diffpy.pdfgui/main/requirements/run.txt
10494

@@ -107,17 +97,21 @@ and then install the package ::
10797
pip install diffpy.pdfgui
10898

10999
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
110-
`GitHub <https://github.com/diffpy/diffpy.pdfgui/>`_. Once installed, ``cd`` into your ``diffpy.pdfgui`` directory
111-
and run the following ::
100+
`GitHub <https://github.com/diffpy/diffpy.pdfgui/>`_. Once installed, ``cd`` into your ``diffpy.pdfgui``
101+
directory and run the following ::
112102

113103
pip install .
114104

115105
Support and Contribute
116106
----------------------
117107

118-
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.pdfgui. Please join the diffpy.pdfgui users community by joining the Google group. The diffpy.pdfgui project welcomes your expertise and enthusiasm!
108+
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general
109+
questions and discussions about the use of diffpy.pdfgui. Please join the diffpy.pdfgui users community
110+
by joining the Google group. The diffpy.pdfgui project welcomes your expertise and enthusiasm!
119111

120-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.pdfgui/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.pdfgui/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
112+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.pdfgui/issues>`_
113+
and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.pdfgui/pulls>`_. You can also post it to the
114+
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
121115

122116
Feel free to fork the project and contribute. To install diffpy.pdfgui
123117
in a development mode, with its sources being directly used by Python
@@ -145,4 +139,5 @@ Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/
145139
Contact
146140
-------
147141

148-
For more information on diffpy.pdfgui please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu.
142+
For more information on diffpy.pdfgui please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge
143+
at sb2896@columbia.edu.

0 commit comments

Comments
 (0)