Installation

You may install the core or the full features set of GEMSEO. See Dependencies for more information.

Requirements

To install GEMSEO, you need a python environment. We strongly recommend to use Anaconda to create a dedicated environment for GEMSEO.

Anaconda

Anaconda is a free multi-platform python distribution (for commercial use and redistribution) that facilitates the installation of python and non-python packages, since it handles pre-compiled packages. Furthermore, it does not require any administrator privilege. You may install Anaconda and learn how to use it.

Environment

This step is optional and only required on Windows or for Python 2.7.

Download this file and create an anaconda environment for GEMSEO with

conda env create -f environment-py3.yml

This will install Python 3.8 and minimum common set of GEMSEO dependencies on any platform (Linux, Windows, MacOS) in an environment named gemseo. You may edit environment-py3.yml to change the environment name or the Python version (3.6, 3.7 or 3.8).

For Python 2, use this file.

Then, activate this environment with:

conda activate gemseo

and you can now proceed with the installation of GEMSEO.

You may leave the anaconda environment with

conda deactivate

Installation

You can install GEMSEO with either the core or the full features set. See Full features for more information about the differences.

There are different ways to install GEMSEO depending on you platform.

Linux or MacOS

This is the easiest way of installing GEMSEO.

Install the full feature set in an anaconda environment named gemseo for python 3.8 with

conda create -c conda-forge -n gemseo python=3.8 gemseo

You can also change the python version to 3.6 or 3.7. For python 2.7, see Install from Pypi (this method also works for any python version but is slightly more complex).

Windows

See Install from Pypi.

Install from Pypi

Create an Environment, then install the core features of the latest version with

pip install gemseo

or the full features with

pip install gemseo[all]

Install from an archive

Create an Environment, then install the core features from an archive with

pip install gemseo-x.y.z.zip

or the full features with

pip install gemseo-x.y.z.zip[all]

Install the development version

Create an Environment, then install the core features of the development version with

pip install git+https://gitlab.com/gemseo/dev/gemseo.git@develop

or the full features with

pip install git+https://gitlab.com/gemseo/dev/gemseo.git@develop#egg=gemseo[all]

Test the installation

Basic test

To check that the installation is successful, try to import the module:

python -c "import gemseo"

Warning

If you obtain the error

“Traceback (most recent call last): File “<string>”, line 1, in <module> ImportError: No module named gemseo“

then the installation failed.

Test with examples

The gallery of examples contains many examples to illustrate the main features of GEMSEO. For each example, you can download a Python script or a Jupyter Notebook, execute it and experiment to test the installation. Furthermore, you can find tutorials mixing several features.

Test with unit tests

Run the tests with:

pip install pytest
pytest

Please have a look at the contributing section for more information on testing.