Merge pull request #89 from dragonyanglong/update_doc

official release v2.0 for py3 version

Author: dragonyanglong

CHANGELOG.md

@@ -2,17 +2,16 @@
 
 Notable differences from version 1.1.2.
 
-## Version 1.4.7 – 2023-04-22
+## Version 2.0.0 – 2023-05-04
 
 ### Added
 
 - Support for Python 3.8, 3.9, 3.10.
-- Use ddp3 to store project files.
+- Use `.ddp3` instead of `.ddp` to store project files.
 
 ### Changed
 
-- Update wxpython to 4.1.1, and remove incompatible align flags.
-- Modify the InsertItem in `plotpanel.py` for Windows.
+- Update wxpython to 4.1.1 and remove incompatible align flags.
 
 ### Deprecated
 
@@ -21,4 +20,4 @@ Notable differences from version 1.1.2.
 ### Fixed
 
 - Incompatible conversion between bytes and str from py2 to py3.
-- Replace the deprecated `Thread.isAlive()` with `Thread.is_alive()`.
+- 

LICENSE.txt

@@ -1,5 +1,15 @@
-This program is part of the DiffPy and DANSE open-source projects
-and is available subject to the conditions and terms laid out below.
+This software was originally developed by the Billinge group as part
+of the Distributed Data Analysis of Neutron Scattering Experiments
+(DANSE) project funded by the US National Science Foundation under
+grant DMR-0520547. Developments of PDFfit2 were funded by NSF grant
+DMR-0304391 in the Billinge group, and with support from Michigan State
+University and Columbia University. Any opinions, findings, and conclusions
+or recommendations expressed in this material are those of the author(s)
+and do not necessarily reflect the views of the respective funding bodies.
+Subsequent development was done in the Billinge group at Columbia University
+and then in collaboration between the Billinge group at Columbia and Pavol
+Juhas at Brookhaven National Laboratory. Moving forward, PDFgui will be
+maintained as a community project with contributions welcomed from many people.
 
 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
@@ -10,9 +20,27 @@ the following paper in your publication:
     PDFgui: computer programs for studying nanostructure in
     crystals, J. Phys.: Condens.  Matter 19, 335219 (2007)
 
+Up to the release 1.1.2 (February 2017) the copyright was held by
+the institutions that hosted the work as follows:
 Copyright 2006-2007, Board of Trustees of Michigan State University,
-Copyright 2008-2017, Board of Trustees of Columbia University in the
-city of New York.  (Copyright holder indicated in each source file).
+Copyright 2008-2012, Board of Trustees of Columbia University in the
+city of New York.
+Copyright 2013, Brookhaven National Laboratory (Copyright holder
+indicated in each source file).
+
+As of February 2017, and the 1.1.2 release, PDFgui has moved to a shared copyright model.
+
+PDFgui uses a shared copyright model. Each contributor maintains copyright over their
+contributions to PDFgui. But, it is important to note that these contributions are
+typically only changes to the repositories. Thus, the PDFgui source code, in its entirety,
+is not the copyright of any single person or institution. Instead, it is the collective
+copyright of the entire PDFgui Development Team. If individual contributors want to
+maintain a record of what changes/contributions they have specific copyright on, they
+should indicate their copyright in the commit message of the change, when they commit
+the change to one of the PDFgui repositories.
+
+The PDFgui Development Team is the set of all contributors to the PDFgui project.
+A full list can be obtained from the git version control logs.
 
 For more information please visit the project web-page:
     https://www.diffpy.org

README.rst

@@ -20,12 +20,12 @@ is available in the doc/Farrow-jpcm-2007.pdf paper.
 REQUIREMENTS
 ------------------------------------------------------------------------
 
-PDFgui requires Python 3.8, 3.9, or 2.7 and several third-party
+PDFgui requires Python 3.7, 3.8, 3.9, or 2.7 and several third-party
 libraries that are used by PDFgui and its components.
 
 * setuptools   - tools for installing Python packages
 * wxpython     - graphical user interface toolkit for Python
-* NumPy        - library for scientific computing with Python
+* numpy        - library for scientific computing with Python
 * matplotlib   - Python 2D plotting library
 * diffpy.pdffit2 - computational engine for PDFgui,
   https://github.com/diffpy/diffpy.pdffit2
@@ -36,17 +36,7 @@ libraries that are used by PDFgui and its components.
 
 We recommend to use `Anaconda Python <https://www.anaconda.com/download>`_
 which allows to conveniently install PDFgui and all its software
-dependencies with a single command.  For other Python distributions
-it is necessary to install the required software separately.  As an
-example, on Ubuntu Linux some of the required software can be
-installed using ::
-
-   sudo apt-get install \
-      python-setuptools python-wxtools python-numpy \
-      python-matplotlib
-
-To install the remaining packages see the installation instructions
-at their respective web pages.
+dependencies with a single command.
 
 Please note that the Python3 PDFgui will read .ddp3 files. It is also
 possible for it to read .ddp files that were saved by the Python2 PDFgui
@@ -97,13 +87,25 @@ If it shows some error like "This program needs access to the screen.". For Mac,
 With Anaconda PDFgui can be later upgraded to the latest released
 version using ::
 
-   conda update diffpy.pdfgui
+   conda update -c conda-forge diffpy.pdfgui
 
 With other Python distributions the program can be upgraded to
 the latest version as follows ::
 
    easy_install --upgrade diffpy.pdfgui
 
+If you would like to use other Python distributions except Anaconda,
+it is necessary to install the required software separately. As an
+example, on Ubuntu Linux some of the required software can be
+installed using ::
+
+   sudo apt-get install \
+      python-setuptools python-wxtools python-numpy \
+      python-matplotlib
+
+To install the remaining packages see the installation instructions
+at their respective web pages.
+
 Other software
 ````````````````````````````````````````````````````````````````````````
 

setup.py

@@ -15,7 +15,7 @@
 
 # Use this version when git data are not available, like in git zip archive.
 # Update when tagging a new release.
-FALLBACK_VERSION = '1.4.7'
+FALLBACK_VERSION = '2.0.0'
 
 # determine if we run with Python 3.
 PY3 = (sys.version_info[0] == 3)

src/diffpy/pdfgui/doc/manual/acknowledgements.texinfo

@@ -1,11 +1,20 @@
-PDFgui was developed as part of the Distributed Analysis of Neutron Scattering
-Data (DANSE) project which is funded by NSF under DMR-0520547.  The PDFfit2
-development was funded by NSF under contract DMR-0304391.  The program is part
-of the DiffPy and DANSE open-source projects at Columbia University and is
-available subject to the conditions and terms laid out below. Several of the
-examples in the tutorial part were made possible and benefited from samples
+This software was originally developed by the Billinge group as part
+of the Distributed Data Analysis of Neutron Scattering Experiments
+(DANSE) project funded by the US National Science Foundation under
+grant DMR-0520547. Developments of PDFfit2 were funded by NSF grant
+DMR-0304391 in the Billinge group, and with support from Michigan State
+University and Columbia University. Any opinions, findings, and conclusions
+or recommendations expressed in this material are those of the author(s)
+and do not necessarily reflect the views of the respective funding bodies.
+Subsequent development was done in the Billinge group at Columbia University
+and then in collaboration between the Billinge group at Columbia and Pavol
+Juhas at Brookhaven National Laboratory. Moving forward, PDFgui will be
+maintained as a community project with contributions welcomed from many people.
+
+Several of the examples in the tutorial part were made possible and benefited from samples
 synthesized by J. F.  Mitchell, and from data collected and processed by M.
 Schmidt, P. G. Radaelli, and X. Qiu.
+
 @bigskip{}
 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
@@ -24,5 +33,19 @@ PDFfit2 and PDFgui: computer programs for studying nanostructure in crystals},
 @insertcopying
 @cindex  copyright
 @bigskip{}
+As of February 2017, and the 1.1.2 release, PDFgui has moved to a shared copyright model.
+@bigskip{}
+PDFgui uses a shared copyright model. Each contributor maintains copyright over their
+contributions to PDFgui. But, it is important to note that these contributions are
+typically only changes to the repositories. Thus, the PDFgui source code, in its entirety,
+is not the copyright of any single person or institution. Instead, it is the collective
+copyright of the entire PDFgui Development Team. If individual contributors want to
+maintain a record of what changes/contributions they have specific copyright on, they
+should indicate their copyright in the commit message of the change, when they commit
+the change to one of the PDFgui repositories.
+@bigskip{}
+The PDFgui Development Team is the set of all contributors to the PDFgui project.
+A full list can be obtained from the git version control logs.
+@bigskip{}
 For more information please visit @url{https://www.diffpy.org}
 or contact Prof. Simon Billinge at @email{sb2896@@columbia.edu}.