If you ended up here to install a local version of GIMS (e.g., to use it offline), make sure that the desktop version provided for download on the GIMS main page is not enough for you. The steps described here require some setup patience. However, you are free to follow them. At the end, you will be able to run the most recent developer version from any branch in the gitlab. So if you can’t wait for the next release … please go ahead!
- The installation involves the following three steps:
Download the Code
Build the client in the
Install the GIMS python application (backend code written in python) in the folder
Obtaining the Code¶
To obtain the source code, please clone the repository (make sure you have deployed you ssh keys on gitlab):
git clone firstname.lastname@example.org:gims-developers/gims.git
We make use of several packages to bundle/build the app and (python) libraries for actually running the app. The most convienient way to quickly install all needed packages is to use the popular package managers
python packages, respectively. There is a lot of material out there in the so called internet about installing these packages on the OS of your choice. In what follows we assume that they are installed on your system.
A quick overview what is needed to follow the installation instructions:
node(node.js includes the package manager
python3.6(this will include
If you hav install the above, then, the following package managers should be already in place:
Building the Client¶
To bundle and finally build the client side of the app we use parcel. Please enter the following in your terminal:
npm install -g parcel-bundler
After that we are ready to install the project. Go to the folder
gims/client/ and type:
npm will automtically install the needed modules. The output of the build process is saved to the
There are two modes availabe:
1. development mode: This mode uses the
2. production mode: This mode uses the
parcel buildoption. It builds the app once and that’s it. To use this mode, type:npm run build
To check whether the build process was successfull, please check if the folder
gims/app/static has any content. If it has we are finished with building of the client side of the application.
Install the GIMS python application¶
We now turn to the server part of your local installation. Please change to the folder
gims/app. You should see now some python files. To isolate your application from dependencies from the rest of your machine we recommend to use python virtual environment. We will briefly discuss the setup of such an environment, first.
Setup a virtual environment¶
pip install virtualenv
Now, setup a new virtual environment:
python3 -m venv env
The settings of this virtual environment are saved in the folder gims/app/env.
Activate the virtual environment with:
Install GIMS app¶
GIMS can be installed like any other python package. Just got to
app folder and type :
pip install -e .[dev]
All dependencies should be installed automatically. A list for all GIMS dependencies can be found in the
setup.py file in the
Start the flask server¶
For the use of GIMS on your local machine we will use the development server from Flask. Please go to the folder
app in the gims folder and type the following in the terminal:
export FLASK_APP=gims flask run
To check if everything works as expected go to your browser and visit (enter in the URL bar):
That’s it! It was a long road to go, though.