Changeset 9533


Ignore:
Timestamp:
Dec 22, 2014 12:15:14 AM (4 years ago)
Author:
wehart
Message:

Updating the installation guide for 4.0

I further stream-lined the quick start examples to
emphasize the use of scientific Python distributions,
and to emphasize the use of pip.

Further, I de-emphasized the use of the pyomo_install
script throughout the document in cases where pip is
a viable option.

Location:
pyomo.doc/trunk/InstallGuide/current
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • pyomo.doc/trunk/InstallGuide/current/PyomoInstallGuide.txt

    r9311 r9533  
    1 Pyomo Installation Guide 3.6 (alpha)
    2 ====================================
     1Pyomo Installation Guide 4.0
     2============================
    33:doctype: book
    44
  • pyomo.doc/trunk/InstallGuide/current/book-start.txt

    r9243 r9533  
    33
    44This book describes different methods for installing the Pyomo
    5 software.  Pyomo is a collection of Python software packages that
    6 supports a diverse set of optimization capabilities for formulating
    7 and analyzing optimization models.  A central component of Pyomo
    8 is Pyomo, which supports the formulation and analysis of mathematical
    9 models for complex optimization applications.  This capability is
    10 commonly associated with algebraic modeling languages (AMLs), which
    11 support the description and analysis of mathematical models with a
    12 high-level language.  Although most AMLs are implemented in custom
    13 modeling languages, Pyomo's modeling objects are embedded within
    14 Python, a full-featured high-level programming language that contains
    15 a rich set of supporting libraries.
     5software.  Pyomo is a Python software package that supports a diverse
     6set of optimization capabilities for formulating and analyzing
     7optimization models.  This capability is commonly associated with
     8algebraic modeling languages (AMLs), which support the description
     9and analysis of mathematical models with a high-level language.
    1610
    1711=== Goals of the Book ===
     
    3428=== Comments and Questions ===
    3529
    36 Further information about Pyomo and Pyomo is available on the Pyomo wiki:
     30Further information about Pyomo and Pyomo is available a the Pyomo home page:
     31
     32    http://pyomo.org
     33
     34The Pyomo software is developed on the following Trac site:
    3735
    3836    https://software.sandia.gov/trac/pyomo
  • pyomo.doc/trunk/InstallGuide/current/intro.txt

    r9243 r9533  
    77for off-line installation are described later in this book.
    88
    9 There are two easy ways to install the latest release: (1) using
    10 the `pip` command and (2) using the `pyomo_install` command.  These
    11 two options have different strengths:  installing with `pip` requires
    12 one less step for the latest version of python, and the `pyomo_install`
    13 script includes additional options to install other packages that
    14 Pyomo can leverage. These options are described in the following
    15 two sections.
    16 
    17 === Installing the Latest Pyomo Release With `pip` ===
    18 
    19 .Step 0: Install Python
    20 
    21 Linux, Mac OS/X and other Unix variants typically have python
    22 pre-installed.  But MS Windows does not!  Make sure that your `PATH`
    23 environment includes the directory that contains python's executables.
     9=== Installing Pyomo ===
     10
     11==== Installing with a Scientific Python Distribution ====
     12
     13Linux, Mac OS/X and other Unix variants typically have Python
     14pre-installed.  However, scientific Python distributions that contain
     15the SciPy Stack include many utilities that Pyomo users will find
     16useful, including SciPy optimizers and MatplotLib plotting capabilities.
     17See SciPy's list of link:http://www.scipy.org/install.html[scientific
     18Python distributions]. 
     19
     20.Step 1: Install Python
     21
     22Many scientific Python distributions are available on Linux, Windows
     23and Mac.  Download and execute an installer that is suitable for
     24your platform.
     25
     26.Step 2: Install Pyomo
     27
     28Scientific Python distributions include the `pip` package that is used
     29to download and install the latest Pyomo release. 
     30The Python
     31installation includes a `bin` or `Scripts` directory that includes a `pip`
     32script.
     33Add this directory to your `PATH` so you can execute the `pip` script. If you have
     34administrator access, then you can install Pyomo in your system
     35Python installation by executing the following in a shell:
     36[[shell]]
     37----
     38pip install Pyomo
     39----
     40You can also install Pyomo in a user's `HOME` directory. This
     41does not require administrator access, but the Pyomo package appears
     42to be installed with the system Python.  Execute the following in
     43a shell:
     44[[shell]]
     45----
     46pip install --user Pyomo
     47----
     48
     49
     50==== Installing with a Standard Python Distribution ====
     51
     52Linux, Mac OS/X and other Unix variants typically have Python
     53pre-installed, and the `python` command will typically be available
     54without modifying your `PATH` environment.
    2455
    2556.Step 1: Install pip
    2657
    27 The `pip` package is used to download and install the latest Pyomo release.  For python versions
    28 before 3.4, the `pip` package will need to be explicitly installed. On
    29 Linux, you may be able to install `pip` with a package manager like
    30 `yum` or `apt-get`.  Alternatively, you can securely download the
     58For Python versions before 3.4, the `pip` package wll need to be
     59explicitly installed.  On Linux, you may be able to install `pip`
     60with a package manager like `yum` or `apt-get`.  Alternatively, you
     61can securely download the
    3162link:https://raw.github.com/pypa/pip/master/contrib/get-pip.py[get-pip.py]
    3263script using your web browser (or a command-line tool like `curl`).
     
    3970.Step 2: Install Pyomo
    4071
    41 The following are alternatives for installing Pyomo in different locations
    42 on your system.
    43 
    44 * *System Python Installation*
    45 +
    46 If you have administrator access, then you can install Pyomo in your system python installation.
     72If you have administrator access, then you can install Pyomo in your system Python installation by executing the following in a shell:
     73[[shell]]
     74----
     75pip install Pyomo
     76----
     77You can also install Pyomo in a user's `HOME` directory. This does not require administrator
     78access, but the Pyomo package appears to be installed with the system Python.
    4779Execute the following in a shell:
    48 +
    49 [[shell]]
    50 ----
    51 pip install Pyomo
    52 ----
    53 +
    54 This installs Pyomo in your system python installation.
    55 
    56 * *Python's Alternate User Installation*
    57 +
    58 You can install Pyomo in the user's `home` directory. This does not require administrator
    59 access, but the Pyomo package appears to be installed with the system python.
    60 Execute the following in a shell:
    61 +
    6280[[shell]]
    6381----
     
    6583----
    6684
    67 
    68 You can start getting help information for Pyomo by executing the following in a shell:
    69 [[shell]]
    70 ----
    71 pyomo --help
    72 ----
    73 
    74 .Step 3: Install Third-Party Packages
    75 
    76 Pyomo has conditional dependencies on a variety of third-party packages.  These are not installed with Pyomo, and many of them can be installed with the `pyomo.extras` package.  The `pip` command can be used to install this package as follows:
     85=== Installing Auxilliary Software ===
     86
     87Pyomo has conditional dependencies on a variety of third-party
     88packages.  These are not installed with Pyomo, and many of them can
     89be installed by installing the `pyomo.extras` package:
    7790[[shell]]
    7891----
    7992pip install pyomo.extras
    8093----
    81 Note that Pyomo has a conditional dependency on the `numpy` and
    82 `scipy` packages.  These are not installed by `pyomo.extras`; they
    83 will need to be installed separately by the user.  Further,
    84 `pyomo.extras` should be installed after these packages are installed;
    85 `pyomo.extras` will conditionally install packages that depend on
    86 `numpy` and `scipy`.
    87 
    88 
    89 === Installing the Latest Pyomo Release With `pyomo_install` ===
    90 
    91 .Step 0: Install Python
    92 
    93 Linux, Mac OS/X and other Unix variants typically have python
    94 pre-installed.  But MS Windows does not!  Make sure that your `PATH`
    95 environment includes the directory that contains python's executables.
    96 
    97 .Step 1: Download `pyomo_install`
    98 
    99 The `pyomo_install` script is used to download and install the
    100 latest Pyomo release.  You can download the
    101 link:https://software.sandia.gov/trac/pyomo/downloader/download/file/70[pyomo_install]
    102 script using your web browser, or you can download from the link
    103 link:https://software.sandia.gov/svn/public/pyomo/pyomo/trunk/scripts/pyomo_install[pyomo_install]
    104 using a command-line tool like `curl`.
    105 
    106 .Step 2: Install Pyomo
    107 
    108 The following are alternatives for installing Pyomo in different locations
    109 on your system.
    110 
    111 * *System Python Installation*
    112 +
    113 If you have administrator access, then you can install Pyomo in your system python installation.
    114 Execute the following in a shell:
    115 +
    116 [[shell]]
    117 ----
    118 pyomo_install
    119 ----
    120 +
    121 This installs Pyomo in your system python installation.
    122 
    123 * *Python's Alternate User Installation*
    124 +
    125 You can install Pyomo in the user's `home` directory. This does not require administrator
    126 access, but the Pyomo package appears to be installed with the system python.
    127 Execute the following in a shell:
    128 +
    129 [[shell]]
    130 ----
    131 pyomo_install --user
    132 ----
    133 
    134 
    135 You can start getting help information for Pyomo by executing the following in a shell:
    136 [[shell]]
    137 ----
    138 pyomo --help
    139 ----
    140 
    141 .Step 3: Install Third-Party Packages
    142 
    143 Pyomo has conditional dependencies on a variety of third-party packages. 
    144 These are not installed with Pyomo, and many of them can be installed with the `pyomo.extras` package. 
    145 You can install `pyomo.extras` with Pyomo by simply using the `--with-extras` option when running `pyomo_install`.  Alternatively, you can directly install `pyomo.extras` using `pip`:
    146 [[shell]]
    147 ----
    148 pip install pyomo.extras
    149 ----
    150 
    151 Note that Pyomo has a conditional dependency on the `numpy` and
    152 `scipy` packages.  These are not installed by `pyomo.extras`; they
    153 will need to be installed separately by the user.  Further,
    154 `pyomo.extras` should be installed after these packages are installed;
    155 `pyomo.extras` will conditionally install packages that depend on
    156 `numpy` and `scipy`.
    157 
    158 
    159 === Getting Started ===
    160 
    161 ==== Install Third-Party Solvers ====
    162 
    163 Most users will want to install third-party solvers to
     94
     95NOTE: that Pyomo has a conditional dependency on the `numpy` and
     96`scipy` packages.  If you explicitly install `numpy` or `scipy`, then
     97`pyomo.extras` should be installed afterward.
     98
     99Pyomo does not include any stand-alone optimization solvers.
     100Consequently, most users will want to install third-party solvers to
    164101analyze optimization models built with Pyomo.  The command
    165102[[shell]]
    166103----
    167 pyomo solvers
     104pyomo help -s
    168105----
    169106provides documentation about Pyomo's solver interfaces, and it will
     
    175112
    176113
    177 ==== Run Python with Pyomo Installed ====
     114=== Getting Started ===
     115
     116==== Running Python ====
    178117
    179118If the +PATH+ environment has been configured to include the system
    180 python installation, then the Pyomo scripts can be executed without
     119Python installation, then the Pyomo scripts can be executed without
    181120further configuration.  The simplest way to get started with Pyomo
    182121is to import the `pyomo` package that you wish to work with.  For
     
    195134packages.
    196135
    197 
    198 ==== Run A NEOS Optimizer ====
     136==== Optimizing with a NEOS Solver ====
    199137
    200138As a quick test of your installation, you can used Pyomo to analyze the
    201139diet problem.  Download the +diet.py+ model file and +diet1.dat+
    202 data file here:
    203 https://software.sandia.gov/svn/public/pyomo/pyomo.core/trunk/examples/pyomo/diet.
     140data file here: https://software.sandia.gov/svn/public/pyomo/pyomo/trunk/examples/pyomo/diet.
     141
    204142If you have network access, then you can run the +pyomo+ command
    205143to optimize this model:
    206144[[shell]]
    207145-----
    208 pyomo --solver-manager=neos --solver=cbc diet1.py diet.dat
     146pyomo solve --solver-manager=neos --solver=cbc diet1.py diet.dat
    209147-----
    210148You should get an output like the following:
     
    226164----
    227165
    228 ==== Run A Locally Installed Optimizer ====
     166==== Optimizing with a Local Solver ====
    229167
    230168The `pyomo` command can also use a solver that is installed
     
    233171[[shell]]
    234172-----
    235 pyomo --solver=glpk diet1.py diet.dat
     173pyomo solve --solver=glpk diet1.py diet.dat
    236174-----
    237175
     
    241179Pyomo is available under the
    242180link:https://software.sandia.gov/trac/pyomo/wiki/Licensing[BSD]
    243 open-source license.  The following table describes different installation options that
    244 are described below:
     181open-source license.  The following table describes standard installation options:
    245182
    246183image::Table_overview_small.png[align="center",alt="Installation Overview"]
     
    249186source is downloaded and where Pyomo is installed.  Pyomo can be installed from
    250187
    251 1. PyPI     - the standard python distribution server
     1881. PyPI     - the standard Python distribution server
    252189
    2531902. ZIP File - a ZIP file that contains Pyomo source files
     
    257194Pyomo can be installed in
    258195
    259 a. System Python         - python's site packages directory
     196a. System Python         - Python's site packages directory
    260197
    261198b. User HOME             - the user's HOME directory
    262199
    263 c. Virtual Environment   - a python virtual environment that is created in a user-specified directory
    264 
    265 Only a subset of these options are recommended for general users, and only a few others are supported
    266 for developers.
     200c. Virtual Environment   - a Python virtual environment that is created in a user-specified directory
     201
     202Only a subset of these options are recommended for general users,
     203and only a few others are supported for developers.
    267204
    268205The <<Prerequisites,Prerequisites>> chapter discusses packages that
    269206you may need to install Pyomo.  Pyomo requires one of the following
    270 python versions: 2.6 2.7, 3.2, 3.3 or 3.4.  Pyomo also requires the
    271 installation of several freely available python libraries, but these
    272 are automatically installed with Pyomo.  This chapter also describes
    273 python packages that may influence the installation of the
    274 `pyomo.extras` package, which installs python packages that enhance
    275 Pyomo's functionality.
     207Python versions: 2.6 2.7, 3.2, 3.3 or 3.4.  Pyomo also requires the
     208installation of several freely available Python libraries, but these
     209are automatically installed with Pyomo.
    276210
    277211Chapter <<InstallingPyomoUsers,Installing Pyomo for Users>> describes
    278212four installation options for Pyomo users.  This chapter discusses
    279 installation with `pyomo_install`, `pip` and MS Windows installers.
     213installation with `pip` and `pyomo_install`.
    280214Chapter <<InstallingPyomoDevelopers,Installing Pyomo for Developers>>
    281215describes three additional installation options for Pyomo developers.
  • pyomo.doc/trunk/InstallGuide/current/issues.txt

    r9243 r9533  
    4545
    4646
    47 
    48 Most Pyomo packages are designed to work with version 2.6 and 2.7.
    49 The Python language underwent some rather large changes in version
    50 3.0.  These changes are not directly backward-compatible with Python
    51 2.x, and consequently Pyomo does not currently work with Python
    52 3.x.
    53 
    5447=== Pyomo Installation ===
    5548
     
    6356
    6457IMPORTANT: Make sure you do ''not'' have the `PYTHONHOME` environment
    65 variable defined prior to installing Pyomo. Such a definition
    66 interferes with the construction of the Pyomo virtualized Python
    67 environment.
     58variable defined prior to installing with `pyomo_install`.  Such a
     59definition interferes with the construction of the Pyomo virtualized
     60Python environment.
    6861
    6962
     
    7871`http://sonproxy.sandia.gov:80` is used for the SON network, and
    7972`http://wwwproxy.sandia.gov:80` is used for the SRN network.
    80 
    81 
    82 ==== Installing on MS Windows ====
    83 
    84 There is a known problem with MS Windows Pyomo installations.  Pyomo
    85 depends on the PyYAML package, which does not install under MS
    86 Windows with the 64-bit Python build.  Thus, Pyomo requires the
    87 32-bit build for MS Windows.
    8873
    8974
     
    123108Subversion does not use the `HTTP_PROXY` environment variable to
    124109configure its behavior. Rather, this must be done by modifying the
    125 local subversion configuration. As expected, this differs on Windows
    126 and Unix platforms, and is environment-specific. However, the
    127 step-by-step process is somewhat generic. Sandia-specific instructions
    128 can be found [sandbox:UsingSubversion here]. The same instructions
    129 should be applicable in other environments by appropriately
    130 substituting the name of your local proxy server.
    131 
     110local subversion configuration.
    132111
    133112=== Python environment variables ===
     
    139118module files.
    140119
    141 Since Pyomo is installed in a virtual Python environment, these
     120When Pyomo is installed in a virtual Python environment, these
    142121environment variables are generally not necessary.  We have seen
    143122many cases where Pyomo scripts failed to operate properly when these
    144123variables were defines, so we generally recommend that the user
    145 disable these variables before installing Pyomo and executing Pyomo
    146 scripts.
     124disable these variables before installing Pyomo in a virtual
     125environment.
    147126
    148127// vim: set syntax=asciidoc:
  • pyomo.doc/trunk/InstallGuide/current/optional.txt

    r9243 r9533  
    77The `pyomo.extras` packages installs a variety of packages that extend Pyomo's functionality, including:
    88
    9 * `Pyro` - This library supports distributed parallel communication in python.
     9* `Pyro` - This library supports distributed parallel communication in Python.
    1010
    1111* `Suds` - This library provides a lightweight SOAP client that is used by `pyomo.neos` to remotely launch optimizers on the NEOS server.
    1212
    13 * `PyYaml` - When this library is installed, many Pyomo packages will Yaml instead of Json for user-friendly I/O.
    14 
    1513* `OpenOpt` - This library provides interfaces for a variety of optimizers.
    1614
     15
     16=== PyYaml ===
     17
     18The default file format used by Pyomo is JSON.  YAML is the default format
     19if the PyYaml package is installed.  On most platforms, this package can be
     20easily installed with `pip`:
     21[[shell]]
     22----
     23pip install PyYaml
     24----
    1725
    1826=== Pywin32 ===
     
    2735The installer for this extension is available from
    2836http://sourceforge.net/projects/pywin32.  This install simply updates
    29 the python site packages.
     37the Python site packages.
    3038
    3139
  • pyomo.doc/trunk/InstallGuide/current/overview.txt

    r9374 r9533  
    99
    1010Users can install Pyomo from PyPI or a ZIP file, and Pyomo can be
    11 installed either in the system python directories or in the user's
     11installed either in the system Python directories or in the user's
    1212HOME directory.  Each of these options are described in the following
    1313sections; there may be multiple ways to install a specific installation
     
    2222option when installing from a ZIP file.
    2323
     24
    2425=== Option 1a: Installation from PyPI into the System Python Directory ===
    2526
    26 This installation option downloads the latest Pyomo release from
    27 PyPI that is installed in the system python installation.  Note
     27This installation option downloads and installs the latest Pyomo release from
     28PyPI into the system Python installation.  Note
    2829that this installation option requires administrator access.
    2930
     
    3940----
    4041
    41 Similarly, the following command uses `pyomo_install` to download and install Pyomo:
    42 [[shell]]
    43 ----
    44 pyomo_install
    45 ----
    46 The `sudo` command may also be required on Linux and Mac systems.
    47 
    4842
    4943=== Option 1b: Installation from PyPI into the User's HOME Directory ===
    5044
    51 This installation option downloads the latest Pyomo release from
    52 PyPI that is installed using python's alternate user installation.
    53 The alternate user installation is included in python's packages,
     45This installation option downloads and installs the latest Pyomo release from
     46PyPI into Python's alternate user installation.
     47The alternate user installation is included in Python's packages,
    5448so this installation option does not require additional customization
    55 of python.
     49of Python.
    5650
    5751NOTE: This installation strategy installs Pyomo in the user's
    5852HOME directory.  The specific directory name depends on the type
    59 of machine;  see the python documentation for further details.
     53of machine;  see the Python documentation for further details.
    6054
    6155The following command uses `pip` to download and install Pyomo:
     
    6458pip install --user pyomo
    6559----
    66 Similarly, the following command uses `pyomo_install` to download and install Pyomo:
    67 [[shell]]
    68 ----
    69 pyomo_install --user
    70 ----
    7160
    7261
    7362=== Option 2a: Installation from a ZIP File into the System Python Directory ===
    7463
    75 This installation option installs Pyomo from a ZIP file, and Pyomo
    76 is installed in the system python installation.  Note that this
    77 installation option requires administrator access.  This installation
    78 is done offline;  no external dependencies are installed and no
    79 network access is required.
     64This installation option installs Pyomo from a ZIP file into the
     65system Python installation.  Note that this installation option
     66requires administrator access.  This installation is done offline;
     67no external dependencies are installed and no network access is
     68required.
    8069
    8170The following command uses `pyomo_install` to extract files from
     
    8675----
    8776
    88 Similarly, MS Windows installers can be used to install Pyomo
    89 releases in the system python installation.  An installer executable
    90 is simply executed to perform installation.  However, the ZIP file
    91 is not specified when executing this installer;  Pyomo ZIP files
    92 are bundled with the MS Windows installers.
    93 
    94 A user can customize the installation process as
    95 follows:
    96 
    97 * The registry is checked to see if a previous Pyomo installation needs to be uninstalled
    98 * The user can optionally install additional Python packages that are used by Pyomo (e.g. PyYAML and PyQt)
    99 * A log of the install process is captured to help diagnose errors
    100 
    101 NOTE: The `PATH` environment
    102 must be edited to include the `Scripts` directory in their Python
    103 installation.  For example, Python 2.6 is normally installed in
    104 `C:\Python26\Scripts`. The `PATH` environment would need to be
    105 appended with `;C:\Python26\Scripts` for the Pyomo executables to
    106 be executed from a DOS shell.
    107 
    10877
    10978=== Option 2b: Installation from a ZIP File into the User's HOME Directory ===
    11079
    111 This installation option installs Pyomo from a ZIP file, and Pyomo
    112 is installed using python's alternate user installation.  This
     80This installation option installs Pyomo from a ZIP file into
     81Python's alternate user installation.  This
    11382installation is done offline;  no external dependencies are installed
    11483and no network access is required.  The alternate user installation
    115 is included in python's packages, so this installation option does
    116 not require additional customization of python.
     84is included in Python's packages, so this installation option does
     85not require additional customization of Python.
    11786
    11887NOTE: This installation strategy installs Pyomo in the user's
    11988HOME directory.  The specific directory name depends on the type
    120 of machine;  see the python documentation for further details.
     89of machine;  see the Python documentation for further details.
    12190
    12291The following command uses `pyomo_install` to extract files from the ZIP file and install Pyomo:
     
    131100== Installing Pyomo for Developers ==
    132101
    133 The following table summarizes all of the different installation options
    134 that are supported for Pyomo:
     102The following table summarizes all of the installation options that
     103are supported for Pyomo:
    135104
    136105image::Table_developers_small.png[align="center",alt="Installation Recommendations for Developers"]
    137106
    138 There are three additional options that are supported for developers, all of which install
    139 Pyomo in a virtual python environment.
    140 A virtual python environment is an isolated python installation
    141 that depends on the system python installation, but which mimics a
    142 complete python installation.  A virtual python environment can be
     107Three additional options are supported for developers,
     108all of which install Pyomo in a virtual Python environment.  A
     109virtual Python environment is an isolated Python installation that
     110depends on the system Python installation, but which mimics a
     111complete Python installation.  A virtual Python environment can be
    143112created by a user in their directory without requiring administrative
    144113privileges.
     
    148117=== Option 1c: Installation from PyPI into a Virtual Environment ===
    149118
    150 This installation option downloads the latest Pyomo release from
    151 PyPI that is installed in a virtual python environment.
     119This installation option downloads and installs the latest Pyomo
     120release from PyPI into a virtual Python environment.
    152121
    153122The following command uses `pyomo_install` to download and install Pyomo:
     
    156125pyomo_install --venv=pyomo
    157126----
    158 The virtual python environment is created in the `pyomo` directory,
    159 and the command `pyomo/bin/python` executes a virtual python
     127The virtual Python environment is created in the `pyomo` directory,
     128and the command `pyomo/bin/python` executes a virtual Python
    160129environment into which Pyomo has been installed.
    161130
     
    163132=== Option 2c: Installation from a ZIP File into a Virtual Environment ===
    164133
    165 This installation option installs Pyomo from a ZIP file, and Pyomo
    166 is installed in a virtual python environment. This installation is
    167 done offline;  no external dependencies are installed and no network
    168 access is required.
     134This installation option installs Pyomo from a ZIP file into a
     135virtual Python environment. This installation is done offline;  no
     136external dependencies are installed and no network access is required.
    169137
    170138The following command uses `pyomo_install` to extract files from the ZIP file and install Pyomo:
     
    173141pyomo_install --zip=pyomo_votd.zip --venv=pyomo
    174142----
    175 The virtual python environment is created in the `pyomo` directory,
    176 and the command `pyomo/bin/python` executes a virtual python
     143The virtual Python environment is created in the `pyomo` directory,
     144and the command `pyomo/bin/python` executes a virtual Python
    177145environment into which Pyomo has been installed.
    178146
     
    181149
    182150This installation option uses subversion to checkout Pyomo packages,
    183 and Pyomo is installed in a virtual python environment.
     151and Pyomo is installed in a virtual Python environment.
    184152
    185 The following command uses `pyomo_install` to extract files from
    186 the ZIP file and install Pyomo:
     153The following command uses `pyomo_install` to checkout and install Pyomo:
    187154[[shell]]
    188155----
    189156pyomo_install --trunk --venv=pyomo
    190157----
    191 The virtual python environment is created in the `pyomo` directory,
    192 and the command `pyomo/bin/python` executes a virtual python
     158The virtual Python environment is created in the `pyomo` directory,
     159and the command `pyomo/bin/python` executes a virtual Python
    193160environment into which Pyomo has been installed.
    194161
    195162[NOTE]
    196163=====
    197 For Option 3c, the `--with-extras` option installs `pyomo.extras` in an +editable+ mode.  If
    198 you wish to install `pyomo.extras` after installing Pyomo, then the following `pip` command
    199 must be executed:
     164For Option 3c, the `--with-extras` option installs `pyomo.extras`
     165in an +editable+ mode.  If you wish to install `pyomo.extras` after
     166installing Pyomo, then the following `pip` command must be executed:
    200167
    201168[[shell]]
  • pyomo.doc/trunk/InstallGuide/current/platforms.txt

    r9243 r9533  
    8080
    8181Similarly, some Ubuntu distributions do not appear to have a full
    82 python 2.6 install. Specifically, the `cProfile` package can be
     82Python 2.6 install. Specifically, the `cProfile` package can be
    8383missing, and will need to be installed.
    8484
  • pyomo.doc/trunk/InstallGuide/current/prereq.txt

    r9243 r9533  
    77Pyomo requires Python versions 2.6, 2.7, 3.2, 3.3 or 3.4. In
    88particular, some components rely on Python modules that exhibited
    9 known bugs in Python 2.4. Further, we rely on and benefit from
    10 several packages and performance improvements introduced in Python
    11 2.6.
     9known bugs in Python 2.5.  We generally recommend installing a
     10scientific Python distribution;  see SciPy's list of
     11link:http://www.scipy.org/install.html[scientific Python distributions].
    1212
    1313* Windows users:
     
    4545to the (32-bit) Python 2.X.Y Windows installer. If you run 32-bit
    4646Python on a 64-bit Windows platform, for example, you will not have
    47 access to more than 3GB of RAM (actually a bit less) - even
    48 when your machine has more.
    49 
    50 Note that several Python distributions are available that are bundled
    51 with third-party packages (e.g. link:http://www.scipy.org/[SciPy]
    52 and link:http://matplotlib.sourceforge.net/[MatPlotLib]):
    53 
    54 * link:http://www.pythonxy.com/[Python(x,y)]
    55 * link:http://www.activestate.com/activepython[ActiveState]
    56 * link:http://www.enthought.com/products/epd.php[Enthought]
     47access to more than 3GB of RAM (actually a bit less) - even when
     48your machine has more.
    5749
    5850
    5951=== Installers ===
    6052
    61 Installing Pyomo requires that one of the following installation tools or executables be downloaded: the `pip` python package, the `pyomo_install` script or the MS Windows installer executable.
     53Installing Pyomo requires that one of the following installation
     54tools or executables be downloaded: the `pip` Python package or the
     55`pyomo_install` script.
    6256
    6357==== Pip ====
    6458
    65 The `pip` package can be used to download and install the latest Pyomo release.  For python versions
     59The `pip` package can be used to download and install the latest Pyomo release.  For Python versions
    6660before 3.4, the `pip` package will need to be explicitly installed. On
    6761Linux, you may be able to install `pip` with a package manager like
     
    8882You can download the
    8983link:https://software.sandia.gov/trac/pyomo/downloader/download/file/70[pyomo_install]
    90 script using your web browser, or you can download from the link
    91 link:https://software.sandia.gov/svn/public/pyomo/pyomo/trunk/scripts/pyomo_install[pyomo_install]
     84script using your web browser, or you can download from
     85[[shell]]
     86----
     87https://software.sandia.gov/svn/public/pyomo/pyomo/trunk/scripts/pyomo_install
     88----
    9289using a command-line tool like `curl`.
    9390
     
    9693depends on.  Specifically, you may need to specify the `HTTP_PROXY`
    9794environment to install from PyPI through a proxy server.  Also,
    98 developers installing the Pyomo trunk may need to configure their
    99 subversion configuration to specify a proxy server.
     95developers installing the Pyomo trunk may need to configure
     96subversion to specify a proxy server.
    10097
    10198NOTE: The `pyomo_install` command has not been developed or tested
     
    104101recommended for that platform.
    105102
    106 NOTE: The `pyomo_install` is a rework of earlier Pyomo installation
    107 scripts, one of which had the name `pyomo_install`.  This new script
    108 does not bundle Python packages.  Instead, it either installs
    109 packages from PyPI or it installs from a ZIP file.
    110 
    111 
    112 ==== The MS Windows Installer ====
    113 
    114 MS Windows installers are available for Pyomo to
    115 install the latest Pyomo release.  These executables install Pyomo
    116 in the system Python installation.  Additionally, these installers
    117 do not require internet access, since they bundle the Pyomo packages
    118 along with the third-party packages that are required by Pyomo.
    119 
    120 You can download the Pyomo installers from the
    121 link:https://software.sandia.gov/trac/pyomo/downloader[Pyomo download
    122 site].  The installers have the name
    123 `Pyomo_VERSION_DATE-setup.exe`.
    124 
    125 
    126 === Numpy and Scipy ===
    127 
    128 Pyomo leverages the `numpy` and `scipy` packages to support `scipy`
    129 optimizers and to enable the initialization of Pyomo models with
    130 `numpy` data structures.  As we noted earlier, these packages are
    131 bundled with some Python distributions.  See the
    132 link:http://www.scipy.org/install.html[SciPy Installation Guide]
    133 for further guidance installing these packages.
     103NOTE: The `pyomo_install` script does not bundle Python packages.
     104Instead, it either installs packages from PyPI or it installs from
     105a ZIP file.
    134106
    135107
     
    144116"CollabNet Subversion Command Line" distribution should be used.
    145117Do ''not'' install "CollabNet Subversion Edge", as it downloads and
    146 installs Python 2.5. While the CollabNet download is free, CollabNet
     118installs Python. While the CollabNet download is free, CollabNet
    147119will require you to create a login - presumably to track usage
    148120statistics. The installer updates the system PATH variable
  • pyomo.doc/trunk/InstallGuide/current/solvers.txt

    r9243 r9533  
    2929
    3030link:https://projects.coin-or.org/Cbc[CBC] is an open-source solver
    31 for linear programs and mixed-integer linear programs.  CBC is
    32 written in C+\+, and it provides a stand-alone executable.
     31for linear programs and mixed-integer linear programs.  CBC provides
     32a stand-alone binary executable.
    3333
    3434See the link:https://projects.coin-or.org/Cbc[CBC wiki] for download
     
    5151defined by the PATH environment variable. There are a variety of
    5252ways that the CPLEX Python environment can be used with Pyomo.
    53 Perhaps the simplest is to install the CPLEX python package.
     53Perhaps the simplest is to install the CPLEX Python package.
    5454
    5555For example, if the
     
    6262pyomo_python setup.py develop
    6363----
    64 The last step installs CPLEX's python package within Pyomo's virtual
     64The last step installs CPLEX's Python package within Pyomo's virtual
    6565environment in developer mode.
    6666
     
    8484mixed-integer programming (MILP and MIQP).
    8585
    86 Although Gurobi Optimizer supports a Python environment, Pyomo only
    87 interfaces with the Gurobi command.   The directory containing the
     86To use Gurobi with Pyomo, the directory containing the
    8887`gurobi.sh` (Linux) or `gurobi.bat` (MS Windows) executable must
    8988be in the list of paths defined by the PATH environment variable.
Note: See TracChangeset for help on using the changeset viewer.