@@ -32,34 +32,35 @@ RTCTree requires Python 2.7. It will not function with an earlier version of
32
32
Python. It has not been tested with Python 3 and it is likely that several
33
33
changes will be necessary to make it function using this version of Python.
34
34
35
+ Sphinx must be installed to build the documentation.
36
+
35
37
36
38
Installation
37
39
============
38
40
39
41
There are several methods of installation available:
40
42
41
- 1. Download the source from either the repository (see "Repository,"
42
- below) or a source archive, extract it somewhere, and install it into
43
- your Python distribution:
44
43
45
- a) Extract the source, e.g. to a directory /home/blag/src/rtctree
44
+ 1. (Preferred method) Use pip to install the PyPi package.
45
+
46
+ a. Install pip if it is not already installed.
47
+ See https://pip.pypa.io/en/latest/installing/
48
+
49
+ b. Execute the following command to install RTCTree::
50
+
51
+ $ pip install rtctree
52
+
53
+ 2. Download the source from either the repository (see "Repository," below) or
54
+ a source archive, extract it somewhere, and install it into your Python
55
+ distribution:
46
56
47
- b) Run setup.py to install RTCTree to your default Python
48
- installation::
57
+ a. Extract the source, e.g. to a directory /home/blag/src/rtctree
49
58
50
- $ python setup.py install
59
+ b. Run setup.py to install RTCTree to your default Python installation::
51
60
52
- c) If necessary, set environment variables. These should be set by
53
- default, but if not you will need to set them yourself. On Windows,
54
- you will need to ensure that your Python site-packages directory is
55
- in the PYTHONPATH variable and the Python scripts directory is in the
56
- PATH variable. Typically, these will be something like
57
- ``C:\Python27\Lib\site-packages\`` and ``C:\Python27\Scripts\``,
58
- respectively (assuming Python 2.7 installed in ``C:\Python27\``).
61
+ $ python setup.py install
59
62
60
- 2. Use the Windows installer. This will perform the same job as running
61
- setup.py (see #2), but saves opening a command prompt. You may still
62
- need to add paths to your environment variables (see step c, above).
63
+ 3. On Windows, use the Windows installer.
63
64
64
65
65
66
Environment variables
0 commit comments