docs: remove .texinfo #170
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #170 +/- ##
=======================================
Coverage 96.85% 96.85%
=======================================
Files 18 18
Lines 795 795
=======================================
Hits 770 770
Misses 25 25 🚀 New features to boost your workflow:
|
|
@sbillinge Please see this, it's ready for review. |
|
New manual Old manual Thanks to Andrew. He rewrote most parts of the old manual to make it readable in html. Section 4 "Available Morphs" in the old manual is not included in the new one. It is about "available morphs and the theory behind", which emphasize more on the theory derivation and less on the program usage instructions. e.g. Thus it is not included. |
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
nice work, please see inline
doc/source/quickstart.rst
Outdated
| Welcome! This will be a quick tutorial to accquaint users with PDFmorph | ||
| and some of what it can do. For a more detailed tutorial, check out | ||
| our :download:`user manual <../manual/pdfmorph.pdf>`. | ||
| and some of what it can do. |
There was a problem hiding this comment.
Here I might think to mention the PDFmorph paper and say something like "To see more details and definitions about the morphs please see the publication describing diffpy.pdfmorph" and give the reference. To begin with reference it using the title and author list and say "to be published"and make an issue to update that when it is submitted to arxiv and update it again when it appears in the journal.
There was a problem hiding this comment.
The current version is this:
doc/source/quickstart.rst
Outdated
| Before you've started this tutorial, please ensure that you've installed | ||
| all necessary software and dependencies. | ||
|
|
||
| In this tutorial, we will demonstrate how to use PDFmorph to compare two PDFs measured from the same material at different temperatures. The morphs showcased include "stretch", "scale", and "smear". |
There was a problem hiding this comment.
this line looks too long, please check it.
There was a problem hiding this comment.
Sure. I cut down every .rst lines' width to 79.
doc/source/quickstart.rst
Outdated
| 1. Within the ``additionalData`` directory, ``cd`` into the ``morphMultiple`` directory. | ||
| 1. Within the ``additionalData`` directory, ``cd`` into the ``morphsequence`` directory. | ||
| Inside, you will find multiple PDFs of :math:`SrFe_2As_2` measured at various temperatures. | ||
| These PDFs are from `"Atomic Pair Distribution Function Analysis: A primer" <https://github.com/Billingegroup/pdfttp_data/>`_. |
There was a problem hiding this comment.
please put a proper reference to the book here. You can also put a link to the data as is done here.
There was a problem hiding this comment.
I replace the book links with https://global.oup.com/academic/product/atomic-pair-distribution-function-analysis-9780198885801
doc/source/quickstart.rst
Outdated
| orthorhombic at lower temperature to tetragonal at higher temperature!) | ||
| orthorhombic at lower temperature to tetragonal at higher temperature!). More sophisticated analysis | ||
| can be done with `PDFgui <https://www.diffpy.org/products/pdfgui.html>`_. | ||
| 8. Finally, let us save all the morphed PDFs into a directory named ``savedMorphs``. :: |
There was a problem hiding this comment.
let's change this to a PEP8 compatible directory name. Maybe saved-morphs
There was a problem hiding this comment.
The suggested directory name is changed now.
doc/source/quickstart.rst
Outdated
| --save=savedMorphs | ||
|
|
||
| Entering the directory with ``cd`` and viewing its contents with ``ls``, we see a file named | ||
| ``Morph_Reference_Table.txt`` with data about the input morph parameters and re- |
There was a problem hiding this comment.
let's also change this so the program outputs morph-reference-table.txt
doc/source/quickstart.rst
Outdated
|
|
||
| Entering the directory with ``cd`` and viewing its contents with ``ls``, we see a file named | ||
| ``Morph_Reference_Table.txt`` with data about the input morph parameters and re- | ||
| fined output parameters and a directory named ``Morphs`` containing all the morphed |
|
@sbillinge It's ready for review. Where can I find the publications list ? Currently it is left blank. |
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
please can you respond to each comment with what action you took.
|
@sbillinge It's ready for review. |
|
codecov will go wrong because the upstream name changed. Redo the PR. |
2 participants
close #167