Skip to content

Commit 216ae10

Browse files
authored
Merge pull request #116 from Sparks29032/manual
Add tutorial for morph sequence and shape
2 parents afd8367 + 08723e1 commit 216ae10

File tree

6 files changed

+196
-97
lines changed

6 files changed

+196
-97
lines changed

README.rst

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -79,24 +79,18 @@ To create and activate a conda environment to use this software, run
7979
the following command from the command line ::
8080
8181
conda create -n pdfmorph_env python=3 --yes
82-
source activate pdfmorph_env
83-
84-
If you're using Windows, replace ``source activate pdfmorph`` with
85-
``activate pdfmorph_env``.
82+
conda activate pdfmorph_env
8683

8784
When you are finished with the session, exit the environment by running ::
8885

89-
source deactivate pdfmorph_env
90-
91-
or, on Windows, ``deactivate pdfmorph_env``.
86+
conda deactivate pdfmorph_env
9287

9388
For your future sessions with the application: Make sure to run the
94-
``source activate pdfmorph_env`` or ``activate pdfmorph_env`` commands
95-
from your command line beforehand to ensure access to the software.
89+
``conda activate pdfmorph_env`` command from your command line beforehand
90+
to ensure access to the software.
9691

9792
Once in your desired conda environment, you can install from either the
98-
"diffpy" or "conda-forge" channels of Anaconda packages by running
99-
either ::
93+
"conda-forge" channel of Anaconda packages by running ::
10094

10195
conda config --add channels conda-forge
10296
conda install diffpy.pdfmorph
@@ -113,7 +107,8 @@ version using ::
113107
USING PDFmorph
114108
------------------------------------------------------------------------
115109

116-
For detailed instructions and full tutorial, consult online documentation.
110+
For detailed instructions and full tutorial, consult our
111+
`online documentation <https://www.diffpy.org/diffpy.pdfmorph/index.html>`_.
117112

118113
Once the required software, including PDFmorph is all installed, open
119114
up a terminal and check installation has worked properly by running ::
@@ -156,9 +151,9 @@ We welcome contributors from the community. Please consider posting issues, and
156151
To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
157152
hooks.
158153

159-
1. Install pre-commit in your working environment by running ``conda install pre-commit``
154+
1. Install pre-commit in your working environment by running ``conda install pre-commit``.
160155

161-
2. Initialize pre-commit (one time only) ``pre-commit install``
156+
2. Initialize pre-commit (one time only) ``pre-commit install``.
162157

163158
Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
164159
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should

doc/manual/source/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ the plotted PDFs.
3535
Finally, we note that though ``PDFmorph`` should work on other spectra
3636
that are not PDFs, it has not been extensively tested beyond the PDF.
3737

38+
To get started, please go to the :ref:`quick_start`.
3839

3940
Authors
4041
-------
@@ -47,8 +48,6 @@ Christopher L. Farrow, Christopher J. Wright, Pavol Juhás, Chia-Hao
4748
For a detailed list of contributors, check `here
4849
<https://github.com/diffpy/diffpy.pdfmorph/graphs/contributors>`_.
4950

50-
To get started, please go to :ref:`quick_start`
51-
5251
.. toctree::
5352
:maxdepth: 3
5453
:hidden:

0 commit comments

Comments
 (0)