QuickStart¶
Install M_Pool¶
The easiest way to install M_Pool is:
pip install m_pool
OR on Linux
sudo pip install m_pool
OR perhaps
pip install --user m_pool
In case of error, see pip Error Messages
Installation From Source¶
Much less common, but if installing from source, then
the best way to install m_pool is still pip
.
After navigating to the directory holding M_Pool source code, do the following:
cd full/path/to/m_pool
pip install -e .
OR on Linux
sudo pip install -e .
OR perhaps
pip install --user -e .
This will execute the local setup.py
file and insure that the pip-specific commands in setup.py
are run.
Running M_Pool¶
After installing with pip
, there will be a launch command line program called m_pool or, on Windows, m_pool.exe. From a terminal or command prompt window simply type:
m_pool
and M_Pool will start. If not, then there may be an issue with your system path. The path for the m_pool executable might be something like:
/usr/local/bin/m_pool (if installed with sudo pip install -e .)
or
/home/<user>/.local/bin/m_pool (if installed with pip install -e .)
or
C:\Python27\Scripts\m_pool.exe (on Windows)
Make sure your system path includes the above path to m_pool.
pip Error Messages¶
If you get an error message that pip
is not found, see https://pip.pypa.io/en/latest/installing.html for full description of pip
installation.
There might be issues with pip
failing on Linux with a message like:
InsecurePlatformWarning
or
Cannot fetch index base URL https://pypi.python.org/simple/
Certain Python platforms (specifically, versions of Python earlier than 2.7.9) have the InsecurePlatformWarning. If you encounter this warning, it is strongly recommended you upgrade to a newer Python version, or that you use pyOpenSSL.
Also pip
may be mis-configured and point to the wrong PyPI repository.
You need to fix this global problem with pip
just to make python usable on your system.
If you give up on upgrading python or fixing pip
,
you might also try downloading the m_pool source package
(and all dependency source packages)
from PyPI and installing from source as shown above at Installation From Source