Skip to content

PDFmorph manual PDF and HTML #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jun 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ version using ::
USING PDFmorph
------------------------------------------------------------------------

For detailed instructions and full tutorial, consult our
`online documentation <https://www.diffpy.org/diffpy.pdfmorph/index.html>`_.
For detailed instructions and full tutorial, consult the user manual
on our `website <www.diffpy.org/diffpy.pdfmorph/>`.
Comment on lines +110 to +111
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference user manual in README.rst.


Once the required software, including PDFmorph is all installed, open
up a terminal and check installation has worked properly by running ::
Expand Down
15 changes: 15 additions & 0 deletions doc/manual/acknowledgements.texinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
The PDFmorph app was developed by the Billinge group at Columbia University.
The examples in the tutorial part of the manual were made possible by data
collected by Soham Banerjee at Brookhaven National Laboratory,
Benjamin Frandsen during his PhD at Columbia Unversity,
and Long Yang from Tonji University.

The DiffPy development team is the set of all contributors to DiffPy projects.
Each member of the development team maintains copyright on their individual
contributions to the code base. For a detailed contribution history of
@code{PDFmorph}, see the git logs at @url{https://github.com/diffpy/diffpy.pdfmorph}.

For more information about the application, please visit
@url{https://www.diffpy.org/diffpy.pdfmorph}.
Report any bugs to diffpy-users@@googlegroups.com or submit
an issue to @url{https://github.com/diffpy/diffpy.pdfmorph/issues}.
Comment on lines +7 to +15
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edited per in-line comment.

10 changes: 10 additions & 0 deletions doc/manual/disclaimer.texinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Binary file added doc/manual/images/ex_tutorial_bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/ex_tutorial_download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/ex_tutorial_params.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/ex_tutorial_stretch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/ex_tutorial_temp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/qs_tutorial_download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/qs_tutorial_morphed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/qs_tutorial_scaled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/images/qs_tutorial_unmorphed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/manual/pdfmorph.pdf
Binary file not shown.
Loading
Loading