Merge pull request #51 from dragonyanglong/update_pdfgui2

update pdfgui webpage into py3 version.

Author: sbillinge

products/PDFgui_LICENSE.txt

@@ -1,20 +1,47 @@
-This software was initially developed at Michigan State University and
-Columbia University as part of the National Science Foundation funded
-DANSE (Distributed data Analysis of Neutron Scattering Experiments)
-project. Continued development is taking place at Brookhaven National
-Laboratory under the complex modeling initiative. The software is
-available subject to the conditions and terms laid out below.
+Copyright Policy
 
+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.
+
+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-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:
     http://www.diffpy.org/
 or email Prof. Simon Billinge at sb2896@columbia.edu
 
+
+License Agreement
+
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

products/pdfgui.rst

@@ -38,54 +38,36 @@ PDFgui is distributed as a software package for
 for all operating systems supported by Anaconda, namely for
 Linux, Mac OS X, and Windows.
 
-As a prerequisite for PDFgui installation, download and
-install **Anaconda Python** from
-|anaconda-download|.
+As a prerequisite for PDFgui installation, download and install
+**Miniconda** (https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links)
+or Anaconda Python (https://www.anaconda.com/download).
 
-.. TODO -- remove when PDFgui is compatible with wxpython 4
+PDFgui is available from the "conda-forge" channel of Anaconda packages.
+To do so open a *Terminal* window or *Anaconda Command Prompt* and use
+the :program:`conda` command as follows ::
 
-.. important::
+   conda create --name=pdfgui2 python=3.9
+   conda activate pdfgui2
+   conda install -c conda-forge diffpy.pdfgui
 
-   As of July 2019 Anaconda stopped providing older versions
-   of several packages that are required by PDFgui
-   (details `here
-   <https://www.anaconda.com/why-we-removed-the-free-channel-in-conda-4-7>`__).
-   We are working on making PDFgui compatible with the current
-   set of Anaconda packages.
-   In the meantime you must re-activate the old packages
-   as follows ::
+PDFgui can be then started from a *Terminal* window or *Anaconda Command Prompt* by typing ::
 
-      conda update -n base conda
-      conda config --set restore_free_channel true
+   pdfgui
 
-
-PDFgui is available from the "diffpy" channel of Anaconda packages.
-Because PDFgui requires Python 2.7 and wxpython 3,
-it is strongly recommended to install it in a dedicated
-Anaconda environment *py27*.
-To do so open a *Terminal* window or *Anaconda Command Prompt* on Windows
-and use the :program:`conda` command as follows ::
-
-   conda config --add channels diffpy
-   conda create --name=py27 python=2.7
-   conda activate py27
-   conda install "diffpy.pdfgui>=1.1.2"
-
-All done.  To start PDFgui enter :program:`pdfgui` command in a
-Terminal or use the *DiffPy* start menu on Windows.  PDFgui can be
-also started from the *Launcher* application included with Anaconda.
+The PDFgui window will appear automatically. An alternative method on Windows is to start
+PDFgui through the *Diffpy* start menu.
 
 .. note::
-   To start PDFgui from a Terminal make sure *py27* is
+   To start PDFgui from a Terminal make sure *pdfgui2* is
    the active Anaconda environment::
 
-      conda activate py27
+      conda activate pdfgui2
 
    Alternatively you can add the following line to your shell startup
    file :file:`.bashrc` to define an alias which will work in
    any Anaconda environment ::
 
-      alias pdfgui="/path/to/py27/bin/pdfgui"
+      alias pdfgui="/path/to/pdfgui2/bin/pdfgui"
 
    where ``/path/to`` needs to be adjusted according to the output of
    ``which pdfgui`` command.
@@ -98,7 +80,7 @@ The Anaconda package system makes it easy to prepare and distribute
 software updates and bugfixes.  To update to the latest version of
 PDFgui use ::
 
-   conda update --channel=diffpy diffpy.pdfgui
+   conda update -c conda-forge diffpy.pdfgui
 
 To use a bleeding edge development version, visit the project source
 repository at https://github.com/diffpy/diffpy.pdfgui and consult
@@ -107,6 +89,15 @@ its README file.
 
 Other versions
 ==============
+v1.1.2 is the last python 2 version of PDFgui. It is no longer supported,
+but may be needed to open python 2 generated `.ddp` project files. It can
+be installed in a python2 anaconda environment using the commands::
+
+   conda config --set restore_free_channel true
+   conda config --add channels diffpy
+   conda create --name=py27 python=2.7
+   conda activate py27
+   conda install -c diffpy "diffpy.pdfgui==1.1.2"
 
 When Anaconda Python is not available, PDFgui can be installed from
 sources.  The latest source package is at the `Python Package
@@ -142,6 +133,15 @@ Documentation and help
 *  The user manual is available in `HTML <../doc/pdfgui/index.html>`__
    and `PDF <../doc/pdfgui/pdfgui.pdf>`__ formats.
 
+*  Search "PDFgui" on YouTube for some video tutorials on how to use
+   PDFgui.
+
+*  For in-depth help in using PDFgui to solve scientific problems please
+   see the book "Atomic Pair Distribution Function Analysis: A primer" by
+   Simon Billinge, Kirsten Jensen, and past and present Billinge group members,
+   published by Oxford University Press. Data for the worked examples can
+   be found here: https://github.com/Billingegroup/pdfttp_data
+
 *  Tutorial files are available from
    `pdfgui-tutorial.zip <../doc/pdfgui/pdfgui-tutorial.zip>`__.