Synchronized with the source at 7c74566.

Author: benfrandsen

NSFnugget.html

@@ -81,7 +81,7 @@
       <li><a href="products/pdfgetx3.html">PDFgetX3</a></li>
       <li><a href="products/pdfgui.html">PDFgui</a></li>
       <li><a href="products/SrMise.html">SrMise</a></li>
-      <li><a href="products/magPDF.html">magPDF</a></li>
+      <li><a href="products/mPDF.html">mPDF</a></li>
       <li><a href="products/pythonpackages.html">Python Packages</a></li>
   </ul>
 </li>

_images/mpdf_screenshot.png

@@ -82,4 +82,4 @@ centered at Columbia University and, before that, Michigan State University.
    products/pdfgetx3
    products/pythonpackages 
    products/SrMise
-   products/magPDF
+   products/mPDF

_sources/index.txt

@@ -0,0 +1,102 @@
+##########
+mpdf
+##########
+
+The diffpy.mpdf package provides a convenient method for computing the magnetic PDF
+(mPDF) from magnetic structures and performing fits to neutron total scattering
+data. The mPDF is calculated by an MPDFcalculator object, which extracts the spin
+positions and spin vectors from a MagStructure object that the MPDFcalculator
+takes as input. The MagStructure object in turn can contain multiple MagSpecies
+objects, which generate magnetic configurations based on a diffpy.Structure object
+and a set of propagation vectors and basis vectors provided by the user.
+Alternatively, the user can manually define a magnetic unit cell that will be used
+to generate the magnetic structure, or the magnetic structure can be defined simply
+as lists of spin positions and spin vectors provided by the user.
+
+
+
+.. figure:: ../images/mpdf_screenshot.png
+   :align: center
+
+This is an early release of mpdf, and the capabilities and documentation of the
+project will evolve. The DiffPy team encourages investigators to provide feedback,
+suggestions, and feature requests.
+
+
+Getting Started
+=================
+
+The diffpy.mpdf package requires Python 2.6 or 2.7 and the following software:
+
+* ``NumPy`` - numerical mathematics and fast array operations for Python
+* ``SciPy`` - scientific libraries for Python
+* ``matplotlib`` - python plotting library
+* ``diffpy.Structure`` - diffpy package for generating atomic structure
+* ``diffpy.srreal`` - diffpy package for calculating real-space quantities
+
+See the :doc:`mpdf license <mPDFlicense>` for terms and conditions of use.
+
+Installation
+------------
+
+The recommended way to install this package is through conda. For help installing conda,
+please visit `https://www.continuum.io/downloads <https://www.continuum.io/downloads>`__.
+Once conda is installed, you can follow the simple steps below to install diffpy.mpdf.
+You will also install the full diffpy-cmi suite along the way. 
+
+*Step 1: Add the appropriate conda channels to your conda configuration.* ::
+
+    conda config --add channels diffpy
+    conda config --add channels benfrandsen
+
+These commands tell conda to look through these channels on the Anaconda cloud server to
+find the appropriate software.
+
+*Step 2 (recommended): Create and activate a conda environment for diffpy + diffpy.mpdf.* ::
+
+    conda create --name diffpy python=2.7
+    source activate diffpy
+
+Note that you can name the environment anything you choose by passing it a different name
+after the --name flag in the first command.
+    
+*Step 3: Install diffpy.mpdf.* ::
+
+    conda install diffpy.mpdf
+
+Note that this will also install the full diffpy-cmi suite if it has not already been
+installed in this environment.
+    
+*Alternative option: Install from the python package index.*
+
+If you prefer to use the python package index and have pip installed, please install the
+prerequisite software and then use the command ::
+
+    pip install diffpy.mpdf
+
+*Alternative option: Download and install from source.*
+
+If you prefer to install from source, you can also zip and download the entire package
+from `PyPI <https://pypi.python.org/pypi/diffpy.mpdf>`__ or
+`GitHub <https://github.com/benfrandsen/diffpy.mpdf>`__, then unzip the file and
+execute the following command from inside the unzipped directory ::
+
+    python setup.py install
+
+Note that this will only work if all the dependencies are already properly installed.
+
+Documentation
+-------------
+Please see `http://pythonhosted.org/diffpy.mpdf/ <http://pythonhosted.org/diffpy.mpdf/>`__
+for the documentation.
+
+What next?
+============
+
+Explore the mpdf tutorial and examples on the
+`CMI Exchange <https://github.com/diffpy/cmi_exchange>`_!
+
+.. toctree::
+   :hidden:
+
+   mPDFlicense

_sources/products/mPDF.txt

@@ -0,0 +1,4 @@
+.. this page only contains the LICENSE text for mPDF
+
+.. include:: mPDF_LICENSE.txt
+   :literal:

_sources/products/mPDFlicense.txt

@@ -81,7 +81,7 @@
       <li><a href="products/pdfgetx3.html">PDFgetX3</a></li>
       <li><a href="products/pdfgui.html">PDFgui</a></li>
       <li><a href="products/SrMise.html">SrMise</a></li>
-      <li><a href="products/magPDF.html">magPDF</a></li>
+      <li><a href="products/mPDF.html">mPDF</a></li>
       <li><a href="products/pythonpackages.html">Python Packages</a></li>
   </ul>
 </li>

acknowledgements.html

@@ -81,7 +81,7 @@
       <li><a href="products/pdfgetx3.html">PDFgetX3</a></li>
       <li><a href="products/pdfgui.html">PDFgui</a></li>
       <li><a href="products/SrMise.html">SrMise</a></li>
-      <li><a href="products/magPDF.html">magPDF</a></li>
+      <li><a href="products/mPDF.html">mPDF</a></li>
       <li><a href="products/pythonpackages.html">Python Packages</a></li>
   </ul>
 </li>

community.html

@@ -80,7 +80,7 @@
       <li><a href="products/pdfgetx3.html">PDFgetX3</a></li>
       <li><a href="products/pdfgui.html">PDFgui</a></li>
       <li><a href="products/SrMise.html">SrMise</a></li>
-      <li><a href="products/magPDF.html">magPDF</a></li>
+      <li><a href="products/mPDF.html">mPDF</a></li>
       <li><a href="products/pythonpackages.html">Python Packages</a></li>
   </ul>
 </li>

index.html

@@ -81,7 +81,7 @@
       <li><a href="pdfgetx3.html">PDFgetX3</a></li>
       <li><a href="pdfgui.html">PDFgui</a></li>
       <li><a href="#">SrMise</a></li>
-      <li><a href="magPDF.html">magPDF</a></li>
+      <li><a href="mPDF.html">mPDF</a></li>
       <li><a href="pythonpackages.html">Python Packages</a></li>
   </ul>
 </li>

products/SrMise.html

@@ -33,7 +33,7 @@
     <link rel="shortcut icon" href="../_static/diffpy_logo_header.ico"/>
     <link rel="top" title="DiffPy  documentation" href="../index.html" />
     <link rel="up" title="SrMise" href="SrMise.html" />
-    <link rel="next" title="magPDF" href="magPDF.html" />
+    <link rel="next" title="mpdf" href="mPDF.html" />
     <link rel="prev" title="SrMise" href="SrMise.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
@@ -82,7 +82,7 @@
       <li><a href="pdfgetx3.html">PDFgetX3</a></li>
       <li><a href="pdfgui.html">PDFgui</a></li>
       <li><a href="SrMise.html">SrMise</a></li>
-      <li><a href="magPDF.html">magPDF</a></li>
+      <li><a href="mPDF.html">mPDF</a></li>
       <li><a href="pythonpackages.html">Python Packages</a></li>
   </ul>
 </li>