Visual Studio Code is free and available on your favorite platform - Linux, macOS, and Windows. Download Visual Studio Code to experience a redefined code editor, optimized for building and debugging modern web and cloud applications. The easy way to get up and running with Spyder on any of our supported platforms is to download it as part of the Anaconda distribution, and use the conda package and environment manager to keep it and your other packages installed and up to date. We recommend the latest 64-bit Python 3 version, unless you have specific requirements that dictate otherwise.
Prerequisites
Install Python
We recommend that you use Pyomo with a scientific Python distribution. Linux, Mac OS/X and other Unix variants typically have Python pre-installed. However, scientific Python distributions that contain the SciPy Stack include many utilities that Pyomo users will find useful, including SciPy optimizers and MatplotLib plotting capabilities. See SciPy’s list of scientific Python distributions.
Install Optimization Solvers
Pyomo does not include any stand-alone optimization solvers. Consequently, most users will need to install third-party solvers to analyze optimization models built with Pyomo.
Note that Pyomo can remote launch optimization solvers on NEOS.
Installing the Latest Pyomo Release
Install Pyomo with pip
Scientific Python distributions include the pip package that is used to download and install the latest Pyomo release. The Python installation includes a bin or Scripts directory that includes a pip script. Add this directory to your PATH so you can execute the pip script. If you have administrator access, then you can install Pyomo in your system Python installation by executing the following in a shell:
Anaconda Python Download Mac
INSTALLING Pyomo with CONDA
Some scientific Python distributions also include the conda package, which can also be used to download and install the latest Pyomo release. You can install Pyomo in your system Python installation by executing the following in a shell:
Installing from source
(Advanced Users and Developers) Pyomo may be installed directly from source by first cloning the main development repository from GitHub:
Then change into the “pyomo” directory that Git just created and run
Conditional Dependencies
Extensions to Pyomo, and many of the contributions in
pyomo.contrib
, also have conditional dependencies on a variety of third-party Python packages including but not limited to: numpy scipy sympy networkx openpxl pyodbc xlrd pandas matplotlib pymysql pyro4 pint
Download Python 3.7
Pyomo extensions that require any of these packages will generate an error message for missing dependencies upon use.
Many of the conditional dependencies are already distributed with most scientific Python distributions. You can check which Python packages you already have installed using the command
pip list
or conda list
. Additional Python packages may be installed as needed.Getting Help
License
Pyomo is available under the BSD license. For more information, see the Pyomo License.
Mac OS X comes with Python 2.7 out of the box.
You do not need to install or configure anything else to use Python 2. Theseinstructions document the installation of Python 3.
The version of Python that ships with OS X is great for learning, but it’s notgood for development. The version shipped with OS X may be out of date from theofficial current Python release,which is considered the stable production version.
Doing it Right¶
Let’s install a real version of Python.
Before installing Python, you’ll need to install GCC. GCC can be obtainedby downloading Xcode, the smallerCommand Line Tools (must have anApple account) or the even smaller OSX-GCC-Installerpackage.
Note
If you already have Xcode installed, do not install OSX-GCC-Installer.In combination, the software can cause issues that are difficult todiagnose.
Note
If you perform a fresh install of Xcode, you will also need to add thecommandline tools by running
xcode-select--install
on the terminal.While OS X comes with a large number of Unix utilities, those familiar withLinux systems will notice one key component missing: a package manager.Homebrew fills this void.
To install Homebrew, open
Terminal
oryour favorite OS X terminal emulator and runThe script will explain what changes it will make and prompt you before theinstallation begins.Once you’ve installed Homebrew, insert the Homebrew directory at the topof your
PATH
environment variable. You can do this by adding the followingline at the bottom of your ~/.profile
fileIf you have OS X 10.12 (Sierra) or older use this line instead
Now, we can install Python 3:
This will take a minute or two.
Pip¶
Homebrew installs
pip
pointing to the Homebrew’d Python 3 for you.Working with Python 3¶
At this point, you have the system Python 2.7 available, potentially theHomebrew version of Python 2 installed, and the Homebrewversion of Python 3 as well.
will launch the Homebrew-installed Python 3 interpreter.
will launch the Homebrew-installed Python 2 interpreter (if any).
will launch the Homebrew-installed Python 3 interpreter.
If the Homebrew version of Python 2 is installed then
pip2
will point to Python 2.If the Homebrew version of Python 3 is installed then pip
will point to Python 3.The rest of the guide will assume that
python
references Python 3.Pipenv & Virtual Environments¶
The next step is to install Pipenv, so you can install dependencies and manage virtual environments.
A Virtual Environment is a tool to keep the dependencies required by different projectsin separate places, by creating virtual Python environments for them. It solves the“Project X depends on version 1.x but, Project Y needs 4.x” dilemma, and keepsyour global site-packages directory clean and manageable.
For example, you can work on a project which requires Django 1.10 while alsomaintaining a project which requires Django 1.8.
So, onward! To the Pipenv & Virtual Environments docs!
This page is a remixed version of another guide,which is available under the same license.