Ubuntu

sudo apt-get install virtualenv

mkdir ~/venv
cd ~/venv
virtualenv -p python3 mrg_py3

Windows

Download git from and Python 64-bit versions from,

• https://www.python.org/ftp/python/3.6.4/python-3.6.4-amd64.exe

and install it taking defaults.

Create a Python virtual environment,

c:\Python36\Scripts\pip.exe install virtualenv
mkdir %HOMEPATH%\venv
cd %HOMEPATH%\venv
c:\Python36\python.exe -m virtualenv mrg_py3

To activate and deactivate the newly created virtual environment using the following commands,

%HOMEPATH%\venv\mrg_py3\Scripts\activate.bat
deactivate

Install as end-user

If there is no need to modify the source code, then it is recommended to install the latest release from the official Python PyPI server.

pip install --upgrade mrg_core

Install from source

For developers of this package, the project source code should be installed using git. Then the dependencies may be installed in the virtual environment using the pip install commands.

mkdir ~/PycharmProjects
cd ~/PycharmProjects
git clone https://gitlab.com/mrg-tools/mrg_test_data.git
git clone https://gitlab.com/mrg-tools/mrg_core.git
pip install -r requirements.txt
pip install -r requirements-dev.txt

sudo apt-get install git
mkdir ~/PycharmProjects
cd ~/PycharmProjects
git clone https://gitlab.com/mrg-tools/mrg_test_data.git
git clone https://gitlab.com/mrg-tools/mrg_core.git
pip install -r requirements.txt
pip install -r requirements-dev.txt

Developer Commands

Activate the virtual environment.

To run the unittests,

cd ~/PycharmProjects/mrg_core
pytest

To run the pylint,

cd ~/PycharmProjects/mrg_core
pylint --rcfile pylint.cfg mrg_core

To build the sphinx documentation,

cd ~/PycharmProjects/mrg_core/docs
make html
# ubuntu
firefox build/html/index.html
# windows
start build/html/index.html