15.1. Installation¶

Sections

System Requirements
- Common
- Windows
- Linux
Install
- Windows
- Linux
Version Upgrade
Reinstall
Uninstall

15.1.1. System Requirements ¶

pSeven Core is a cross-platform package. There are common requirements for the Python environment and some platform-specific details for Windows and Linux.

15.1.1.1. Common ¶

Supported Python versions: 2.7, 3.6 or newer.
NumPy version 1.6.0 or newer for Python 2 and version 1.11.2 or newer for Python 3.

NumPy is required to run pSeven Core, but is not needed for installation. In case when the setup script does not find it, the installation completes successfully, but the installer issues a warning asking to install NumPy.

Optional:

SciPy — a scientific programming library, used in some code examples.
Matplotlib — a plotting library, used in many code examples. Should be at least version 1.1.
SHAP — an implementation of the approach to explain model output, may be required only by gtapprox.Model.shap_value() and only for certain models.

15.1.1.2. Windows ¶

pSeven Core is tested on the following Windows versions which are officially supported:

Windows 7/8/8.1/10, 32-bit and 64-bit editions.

Other versions which were not tested extensively, but should also support pSeven Core, include:

Windows Server 2008 R2.
Windows Home Server 2011.
Windows Server 2012.
Windows Server 2012 R2.
Windows Server 2016.

There are no special requirements for Windows systems, but note the common requirements above. Python is not included with Windows by default and must be installed before pSeven Core.

15.1.1.3. Linux ¶

pSeven Core will work in any x86_64 Linux-based OS satisfying the following requirements:

Linux kernel version 2.6.18 or newer.
GNU C Library (glibc) version 2.5 or newer.

15.1.2. Install ¶

pSeven Core is a standard Python package and is installed using Distutils. This section provides a brief standard installation guide. See the Python documentation if you are looking for more details or need to customize your installation.

15.1.2.1. Windows ¶

Warning

In Windows, pSeven Core cannot be installed if the path to setup.py contains 254 or more characters. If you get an error like “no such file or directory” or “the file name you specified is not valid”, move the package to install from a shorter path.

Installing as Administrator

Extract files from the archive and run:

> python setup.py install

Installing as an unprivileged user

Extract files from the archive and run:

> python setup.py install --user

The package is installed to %APPDATA%\Python\PythonXY\site-packages, where XY is the Python version (without the dot) used to run the setup.py script. The package name is da.

Note

Register your license after installation to be able to use pSeven Core tools. See section License Setup for details.

15.1.2.2. Linux ¶

Installing as a privileged user (root)

Extract files from the archive and run:

$ python setup.py install

Installing as an unprivileged user

Extract files from the archive and run:

$ python setup.py install --user

The package is installed to ~/.local/lib/pythonX.Y/site-packages, where X.Y is the Python version used to run the setup.py script. The package name is da.

Note

Register your license after installation to be able to use pSeven Core tools. See section License Setup for details.

15.1.3. Version Upgrade ¶

Different versions of pSeven Core can be installed side-by-side on the same host. This is the default installation mode when you do a version upgrade: a new version does not replace an older version, both are kept on the disk, and the new version becomes default. For the details on how different versions are handled, see the da package description.

While side-by-side installation does not break the compatibility on script level, in certain cases it may be considered a maintenance issue (see Version Compatibility Issues for the version 1.7.6).

If you would like to keep the latest version only, remove the existing installation first, following the instructions in section Uninstall.

15.1.4. Reinstall ¶

You can reinstall any existing version by running its setup.py with an added --force option, for example:

$ python setup.py install --force --user

It allows the script to overwrite existing files for this version and may be used to repair an installation. Other installed versions are not affected.

15.1.5. Uninstall ¶

To uninstall all pSeven Core packages, manually remove the da directory and all pSevenCore-x.x.xxx-pyX.Y.egg-info files from the directory where pSeven Core is installed (see the paths in the Install section).

To uninstall a specific version n.n.nnn, manually remove the p7core_n_n_nnn directory inside the da directory, and remove the pSevenCore-n.n.nnn-pyX.Y.egg-info file, paying attention to the version number.