diff --git a/README.rst b/README.rst index c476e9f..60966ec 100644 --- a/README.rst +++ b/README.rst @@ -75,8 +75,8 @@ REQUIREMENTS ------------------------------------------------------------------------ PDFmorph is currently run from the command line, which requires opening -and typing into a terminal window or Windows command prompt. It is -recommended that you consult online resources and become somewhat +and typing into a terminal window or Windows command prompt. It is +recommended that you consult online resources and become somewhat familiar before using PDFmorph. PDFmorph can be run with Python 3.10 or higher. It makes use of several third party @@ -160,7 +160,7 @@ Support and Contribute `Diffpy user group `_ is the discussion forum for general questions and discussions about the use of diffpy.pdfmorph. Please join the diffpy.pdfmorph users community by joining the Google group. The diffpy.pdfmorph project welcomes your expertise and enthusiasm! -If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_. +If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_. Feel free to fork the project and contribute. To install diffpy.pdfmorph in a development mode, with its sources being directly used by Python diff --git a/TUTORIAL.rst b/TUTORIAL.rst index 1cee58c..114ebd2 100644 --- a/TUTORIAL.rst +++ b/TUTORIAL.rst @@ -183,5 +183,5 @@ Enjoy the software! Bug Reports ----------- -Please enjoy using our software! If you come accross any bugs in the +Please enjoy using our software! If you come accross any bugs in the application, please report them to diffpy-dev@googlegroups.com diff --git a/doc/source/index.rst b/doc/source/index.rst index 2a2bde3..eebd546 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,33 +10,33 @@ diffpy.pdfmorph - Tools for manipulating and comparing PDF profiles. Introduction ++++++++++++ -``PDFmorph`` is a Python package that increases the insight -researchers can obtain from measured atomic pair distribution functions -(PDFs) in a model-independent way. It was designed to help a -researcher answer the question: "Has my material undergone a phase +``PDFmorph`` is a Python package that increases the insight +researchers can obtain from measured atomic pair distribution functions +(PDFs) in a model-independent way. It was designed to help a +researcher answer the question: "Has my material undergone a phase transition between these two measurements?" -One approach is to compare the two PDFs in a plot and view the -difference curve underneath. However, significant signal can be seen in -the difference curve from benign effects such as thermal expansion (peak -shifts) and increased thermal motion (peak broadening) or a change in -scale due to differences in incident flux, for example. ``PDFmorph`` will -do its best to correct for these benign effects before computing and -plotting the difference curve. One measured PDF (typically that -collected under higher temperature) is identified as the target PDF and +One approach is to compare the two PDFs in a plot and view the +difference curve underneath. However, significant signal can be seen in +the difference curve from benign effects such as thermal expansion (peak +shifts) and increased thermal motion (peak broadening) or a change in +scale due to differences in incident flux, for example. ``PDFmorph`` will +do its best to correct for these benign effects before computing and +plotting the difference curve. One measured PDF (typically that +collected under higher temperature) is identified as the target PDF and the second PDF is then morphed by "stretching" (changing the r-axis to -simulate a uniform lattice expansion), "smearing" (broadening peaks -through a uniform convolution to simulate increased thermal motion), and -"scaling" (self-explanatory). PDFmorph will vary the amplitude of the -morphing transformations to obtain the best fit between the morphed and -the target PDFs, then plot them on top of each other with the difference +simulate a uniform lattice expansion), "smearing" (broadening peaks +through a uniform convolution to simulate increased thermal motion), and +"scaling" (self-explanatory). PDFmorph will vary the amplitude of the +morphing transformations to obtain the best fit between the morphed and +the target PDFs, then plot them on top of each other with the difference plotted below. There are also a few other morphing transformations in the program. If no morphing transformation is specified, ``PDFmorph`` will return just the plotted PDFs. -Finally, we note that though ``PDFmorph`` should work on other spectra +Finally, we note that though ``PDFmorph`` should work on other spectra that are not PDFs, it has not been extensively tested beyond the PDF. To get started, please download our :download:`user manual <../manual/pdfmorph.pdf>` @@ -46,8 +46,8 @@ or visit the :ref:`quick_start`. Authors ======= -``PDFmorph`` is developed by members of the Billinge Group at -Columbia University and Brookhaven National Laboratory including +``PDFmorph`` is developed by members of the Billinge Group at +Columbia University and Brookhaven National Laboratory including Christopher L. Farrow, Christopher J. Wright, Pavol Juhás, Chia-Hao (Timothy) Liu, Andrew Yang, and Simon J. L. Billinge. diff --git a/doc/source/license.rst b/doc/source/license.rst index cfab61c..9ae52a9 100644 --- a/doc/source/license.rst +++ b/doc/source/license.rst @@ -9,9 +9,9 @@ OPEN SOURCE LICENSE AGREEMENT ============================= BSD 3-Clause License -Copyright (c) 2024, The Trustees of Columbia University in +Copyright (c) 2024, The Trustees of Columbia University in the City of New York. -All Rights Reserved. +All Rights Reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/requirements/README.txt b/requirements/README.txt index dc34909..3de372a 100644 --- a/requirements/README.txt +++ b/requirements/README.txt @@ -2,7 +2,7 @@ # # This directory is where you should place your project dependencies. # "pip.txt" should contain all required packages not available on conda. -# All other files should contain only packages available to download from conda. +# All other files should contain only packages available to download from conda. # build.txt should contain all packages required to build (not run) the project. # run.txt should contain all packages (including optional packages) required for a user to run the program. # test.txt should contain all packages required for the testing suite and to ensure all tests pass.