Skip to content

Writing Tutorials #81

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

Closed
wants to merge 12 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Add new tutorial files
  • Loading branch information
Andrew Yang committed Jul 3, 2023
commit a16d57cab7fed2759662807949d09f2c88379dd2
6 changes: 3 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Release Notes
.. current developments

v0.0.1
====================
------

**Changed:**
**Added:**

* Fixed rever GH address
* INSERT SYNOPSIS
4 changes: 4 additions & 0 deletions diffpy/pdfmorph/pdfplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,11 @@ def comparePDFs(
:param show: Show the plot (default True).
:param maglim: Point after which to magnify the signal by mag. If None (default), no magnification will take
place.
<<<<<<< Updated upstream
:param mag: Magnification factor (default 5).
=======
:param mag: Magnification factor (default 5)
>>>>>>> Stashed changes
:param rw: Rw value to display on the plot, if any.
:param legend: Display the legend (default True).

Expand Down
6 changes: 5 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ Christopher L. Farrow, Christopher J. Wright, Pavol Juhás, Chia-Hao
For a detailed list of contributors, check `here
<https://github.com/diffpy/diffpy.pdfmorph/graphs/contributors>`_.

To get started, please go to :ref:`quick_start`
..
Add user manual.

To get started, please go to :ref:`quick_start`. The same information can be found on the user
available in both PDF and HTML formats.

.. toctree::
:maxdepth: 3
Expand Down
15 changes: 12 additions & 3 deletions doc/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before you've started this tutorial, please ensure that you've installed
all necessary software and dependencies.

Basic PDFmorph Workflow
-----------------------
=======================

1. Open your Terminal or Command Prompt.

Expand Down Expand Up @@ -179,11 +179,20 @@ Enjoy the software!
.. Additional PDFmorph Functionality/Exploration
.. ---------------------------------------------

.. TODO include undoped PDF example, phase changed PDFs, and nano/non-nano PDFs
.. TODO include undoped PDF example, phase changed PDFs

Extras
======

Bug Reports
Morph Shape
-----------


Morphing Across a Directory
---------------------------

Bug Reports
===========

Please enjoy using our software! If you come accross any bugs in the
application, please report them to diffpy-dev@googlegroups.com.
Binary file added tutorial/advancedData/__MACOSX/._advancedData
Binary file not shown.
4,004 changes: 4,004 additions & 0 deletions tutorial/advancedData/__MACOSX/advancedData/._ni_qmax25.cgr

Large diffs are not rendered by default.

4,006 changes: 4,006 additions & 0 deletions tutorial/advancedData/__MACOSX/advancedData/._ni_qmax25_e17.5_p5.0.cgr

Large diffs are not rendered by default.

4,005 changes: 4,005 additions & 0 deletions tutorial/advancedData/__MACOSX/advancedData/._ni_qmax25_psize35.cgr

Large diffs are not rendered by default.

4,004 changes: 4,004 additions & 0 deletions tutorial/advancedData/advancedData/ni_qmax25.cgr

Large diffs are not rendered by default.

4,006 changes: 4,006 additions & 0 deletions tutorial/advancedData/advancedData/ni_qmax25_e17.5_p5.0.cgr

Large diffs are not rendered by default.

4,005 changes: 4,005 additions & 0 deletions tutorial/advancedData/advancedData/ni_qmax25_psize35.cgr

Large diffs are not rendered by default.