Skip to content

Commit 7119cc9

Browse files
committed
Synchronise installation instructions with paper supplementary material
1 parent fd1f8dd commit 7119cc9

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

documentation/source/installation.rst

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
Installation
33
============
44

5-
PySCeSToolbox is compatible with Mac OS X, Linux, and Windows. Operating system
6-
specific instructions are discussed in the sections below. We have made special
7-
effort to provide as detailed instructions as possible, basically assuming a
5+
PySCeSToolbox is compatible with Mac OS X, Linux, and Windows. Operating
6+
system-specific instructions are discussed in the sections below. We have made
7+
special
8+
effort to provide as detailed instructions as possible, assuming a
89
clean installation of each operating system prior to installation of
910
PySCeSToolbox, and relatively limited knowledge of Python. If further
10-
assistance is required, please contact the authors.
11+
assistance is required, please contact the developers.
1112

1213
Abbreviated requirements
1314
------------------------
1415

15-
PySCeSToolbox also has a number of requirements that must be met before
16+
PySCeSToolbox has a number of requirements that must be met before
1617
installation can take place. Fortunately most requirements, save for a few
17-
exceptions (as discussed in the operating system specific sections), will be
18+
exceptions (as discussed in the operating system-specific sections), will be
1819
taken care of automatically during installation. An abbreviated list of
1920
requirements follows:
2021

@@ -29,7 +30,8 @@ Windows
2930
-------
3031

3132
Windows requires the manual installation of **Python 2.7**,
32-
**PySCeS** and **Maxima**. Windows 8 and 10 were used in our tests.
33+
**PySCeS** and **Maxima**. Installation was tested on Windows 8 and
34+
10.
3335

3436
Python
3537
~~~~~~
@@ -38,7 +40,7 @@ For Windows users (especially those unfamiliar with Python) we recommend using
3840
the Anaconda Python distribution
3941
(https://www.continuum.io/downloads#windows). This is a low fuss solution
4042
that will install Python on you system *together with many of the packages
41-
necessary for running PySCeSToolbox*. Download the appropriate Python 2.7
43+
necessary for running PySCeSToolbox*. Download the appropriate **Python 2.7**
4244
package from the download page (most probably the 64bit edition) and follow the
4345
instructions of the installation wizard.
4446

@@ -47,7 +49,7 @@ PySCeS
4749
After installing Anaconda, download and install the latest PySCeS binary
4850
package from \break http://pysces.sourceforge.net/download.html. PySCeS can also
4951
be built from source (for more details see the instructions given at the
50-
provided url).
52+
provided URL).
5153

5254
Maxima
5355
~~~~~~
@@ -58,7 +60,7 @@ download page at http://maxima.sourceforge.net/download.html.
5860

5961
Windows might also require the path to ``maxima.bat`` to be defined in the
6062
``psctb_config.ini`` file (found at ``C:\Pysces\psctb_config.ini`` by default).
61-
The default path included ``psctb_config.ini`` is set as ``C:\Program
63+
The default path included in ``psctb_config.ini`` is set as ``C:\Program
6264
Files?\Maxima?\bin\maxima.bat``, where the question marks are wildcards
6365
(since the specific path will depend on the version of Maxima). If Maxima has
6466
been installed to a user specified directory, the correct path to the
@@ -85,13 +87,13 @@ Mac OS X (MacOS)
8587
Mac OS X requires the manual installation of **PySCeS** and **Maxima**. While
8688
OS X comes pre-installed with **Python 2.7** we still recommend installing a
8789
Python distribution such as Anaconda as it will take care of many of the SciPy
88-
stack requirements. MacOS Sierra was used in our tests.
90+
stack requirements. Installation was tested on MacOS Sierra.
8991

9092
Python
9193
~~~~~~
9294
One of the most simple ways to get Python on your system is to install the
9395
Anaconda Python distribution (https://www.continuum.io/downloads#macos).
94-
Download the either of the Python 2.7 installers from the download page and
96+
Download either of the Python 2.7 installers from the download page and
9597
follow the provided instructions.
9698

9799
PySCeS
@@ -118,8 +120,9 @@ popup (the full xcode package is *not required*. Gfortran dmg's for your
118120
particular version of OS X (or MacOS) can downloaded and installed from
119121
http://gcc.gnu.org/wiki/GFortranBinaries.
120122

121-
Once the appropriate compilers are present this step may be skipped as PySCeS
122-
will be installed automatically when PySCeSToolbox is installed.
123+
Once the appropriate compilers are present the actual PySCeS install may be
124+
skipped as PySCeS will be installed automatically when PySCeSToolbox is
125+
installed.
123126

124127
Maxima
125128
~~~~~~
@@ -163,9 +166,9 @@ Linux
163166
-----
164167
165168
Linux requires the manual installation **Maxima** and **PySCeS**.
166-
Most Linux systems comes pre-installed with **Python 2.7**, however a
167-
Python distribution such as Anaconda may be used instead. Ubuntu 16.04 was used
168-
in our tests.
169+
Most Linux systems come pre-installed with **Python 2.7**, however a
170+
Python distribution such as Anaconda may be used instead. Installation
171+
was tested on Ubuntu 16.04.
169172
170173
Python
171174
~~~~~~
@@ -186,10 +189,13 @@ with the command:
186189
187190
pip install pysces
188191
189-
Both cases requires the gcc, g++, and gfortran compilers to be present on the
192+
Both cases require the gcc, g++, and gfortran compilers to be present on the
190193
system. These compilers are most probably available from your OS's
191-
repositories. If the appropriate compilers are present this step may be skipped
192-
as PySCeS will be installed automatically when PySCeSToolbox is installed.
194+
repositories.
195+
196+
Once the appropriate compilers are present the actual PySCeS install may be
197+
skipped as PySCeS will be installed automatically when PySCeSToolbox is
198+
installed.
193199
194200
Maxima
195201
~~~~~~

0 commit comments

Comments
 (0)