From 02ee03ffb256642131064e2b92149272cca5342b Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Thu, 22 Oct 2015 23:12:43 -0400 Subject: [PATCH] [Doc] Mention IPython and Matplotlib in installation instructions --- doc/sphinx/install.rst | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/doc/sphinx/install.rst b/doc/sphinx/install.rst index c953d6360..a637d003b 100644 --- a/doc/sphinx/install.rst +++ b/doc/sphinx/install.rst @@ -68,7 +68,7 @@ installation instructions are for Cantera 2.2.0. c:\python34\python.exe "%USERPROFILE%\Downloads\get-pip.py" -4. **Install Numpy** +4. **Install Numpy and optional Python packages** - Go to the `Unofficial Windows Binaries for Python Extension Packages page `_. @@ -85,6 +85,12 @@ installation instructions are for Cantera 2.2.0. c:\python34\scripts\pip.exe install "%USERPROFILE%\Downloads\numpy‑1.8.2+mkl‑cp34‑none‑win_amd64.whl" + - If you plan on using Cantera from Python, you may also want to install + IPython (an advanced interactive Python interpreter) and Matplotlib (a + plotting library), which are also available from the above link (note that + you may also need to download additional dependencies for each of these + packages). Matplotlib is required to run some of the Python examples. + 5. **Remove old versions of Cantera** - Use The Windows "Add/Remove Programs" interface @@ -207,11 +213,22 @@ you can skip any steps which have already been completed. Note that these packages are required even if you do not plan on using the Cantera Python 2 module. + - If you plan on using Cantera from Python, you may also want to install + IPython (an advanced interactive Python interpreter) and Matplotlib (a + plotting library). Matplotlib is required to run some of the Python + examples:: + + pip install ipython matplotlib + - If you want to build the Cantera Python 3 module, run:: brew install python3 pip3 install numpy cython + and, optionally:: + + pip3 install ipython matplotlib + 3. **Compile and install Cantera** * To compile and install Cantera using the default configuration, run:: @@ -331,3 +348,15 @@ To install all of the Cantera packages:: sudo aptitude install cantera-python cantera-python3 cantera-dev or install whichever subset you need by adjusting the above command. + +If you plan on using Cantera from Python, you may also want to install IPython +(an advanced interactive Python interpreter) and Matplotlib (a plotting +library), which are also available from the above link. Matplotlib is required +to run some of the Python examples. For Python 2, these packages can be +installed with:: + + sudo aptitude install ipython python-matplotlib + +And for Python 3, these packages can be installed with:: + + sudo aptitude install ipython3 python3-matplotlib