Skip to content

Commit 76f0294

Browse files
committed
Update installation section
1 parent 13435df commit 76f0294

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

products/pdfmorph.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -56,34 +56,35 @@ Installation
5656
By downloading and using this software, you are agreeing to the conditions
5757
specified in the :doc:`software license <pdfmorph_license>`.
5858

59-
In order to take automatically take care of software dependency
60-
downloads, we recomment you install PDFmorph using conda. To do that,
61-
you will first have to download and install *Anaconda* or *mini-conda*
62-
from `continuum <https://www.continuum.io>`__.
63-
64-
PDFmorph is available for all operating systems supported by Anaconda,
65-
namely for 32 and 64-bit Linux, Mac OS X, and 32 and 64-bit Windows.
59+
PDFmorph will run on Python 2.7 or higher, but here we give instructions
60+
for installing the Python 3 version in a conda environment.
6661

6762
.. note::
68-
We recommend that you run PDFmorph in a Python 3 conda virtual
69-
environment. With Anaconda or mini-conda installed on your system,
70-
first create the virtual environment by typing ::
63+
PDFmorph is distributed and best installed using conda. It should
64+
run in most Python 3 environments and can be directly installed
65+
in an existing environment (using the commands listed below). If
66+
you do not currently have conda installed, here are some
67+
lightweight instructions for getting started:
68+
69+
1.) Download and install *Anaconda* or *mini-conda* from
70+
`continuum <https://www.continuum.io>`__.
71+
72+
2.) Create a Python 3 environment with the command ::
7173
72-
conda create --name=<env_name> python=3
74+
conda create --name=<env_name> python=3
7375

74-
You can give the environment any name you like but it should
75-
have some Python version 3 installed (though PDFmorph also works
76-
on Python 2.7). You only need to create the environment once,
77-
but every time you want to use PDFmorph you will have to
78-
reactivate the environment in which it is installed by typing ::
76+
You can give the environment any name you like.
77+
You only need to create the environment once, but every time you
78+
want to use PDFmorph you will have to reactivate the environment
79+
in which it is installed by opening a terminal and typing ::
7980
8081
source activate <env_name>
8182

8283
on Mac/Linux, or ``activate <env_name>`` on Windows.
8384

8485
Once you're in your desired conda environment, you can install PDFmorph
8586
from either the ``diffpy`` or ``conda-forge`` channels of Anaconda packages
86-
by running opening a *Terminal* window or *Anaconda Command Prompt*
87+
by running opening a *Terminal* window or *Command Prompt*
8788
on Windows and using the :program:`conda` command ::
8889

8990
conda config --add channels conda-forge

products/pythonpackages.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Module Description
4141

4242
`diffpy.pdfmorph`_ Tools for comparing and manipulating two
4343
PDFs.
44+
4445
====================== ============================================
4546

4647
.. _diffpy.srfit: https://github.com/diffpy/diffpy.srfit

0 commit comments

Comments
 (0)