Installation

This guide contains detailed installation instructions for Linux, OS X and Windows.

It covers the installation of the mosaik framework followed by the instructions to install the demo.

Linux

This guide is based on (K)ubuntu 18.04 Bionic Beaver, 64bit.

Mosaik and the demo scenario require Python >= 3.8, which should be fine for any recent linux distribution. Note that we test mosaik only for the most (typically three) recent python versions though.

We also need pip, a package manager for Python packages, and virtualenv, which can create isolated Python environments for different projects:
```
$ wget https://bootstrap.pypa.io/get-pip.py
$ sudo python get-pip.py
$ sudo pip install -U virtualenv
```
Now we need to create a virtual environment for mosaik and its dependencies. The common location for venvs is under ~/.virtualenvs/:
```
$ virtualenv -p /usr/bin/python3 ~/.virtualenvs/mosaik
$ source ~/.virtualenvs/mosaik/bin/activate
```
Your command line prompt should now start with “(mosaik)” and roughly look like this: (mosaik)user@kubuntu:~$.
The final step is to install mosaik:
```
(mosaik)$ pip install mosaik
```
Mosaik should now be installed successfully.

Running the demo

Mosaik alone is not very useful (because it needs other simulators to perform a simulation), so we also provide a small demo scenario and some simple simulators as well as a mosaik binding for PYPOWER.

PYPOWER requires NumPy and SciPy. We also need to install the revision control tool git. You can use the packages shipped with Ubuntu. We use apt-get to install NumPy, SciPy, and h5py as well as git. By default, venvs are isolated from globally installed packages. To make them visible, we also have to recreate the venv and set the --system-site-packages flag:
```
$ sudo apt-get install git python3-numpy python3-scipy python3-h5py
$ rm -rf ~/.virtualenvs/mosaik
$ virtualenv -p /usr/bin/python3 --system-site-packages ~/.virtualenvs/mosaik
$ source ~/.virtualenvs/mosaik/bin/activate
```
You can now clone the mosaik-demo repository into a folder where you store all your code and repositories (we’ll use ~/Code/):
```
(mosaik)$ mkdir ~/Code
(mosaik)$ git clone https://gitlab.com/mosaik/mosaik-demo.git ~/Code/mosaik-demo
```
Now we only need to install all requirements (mosaik and the simulators) and can finally run the demo:
```
(mosaik)$ cd ~/Code/mosaik-demo/
(mosaik)$ pip install -r requirements.txt
(mosaik)$ python demo.py
```
If no errors occur, the last command will start the demo. The web visualisation shows the demo in your browser: http://localhost:8000. You can click the nodes of the topology graph to show a time series of their values. You can also drag them around to rearrange them.

You can cancel the simulation by pressing Ctrl-C.

OS X

This guide is based on OS X 10.11 El Capitan.

Mosaik and the demo scenario require Python >= 3.8. OS X only ships with some outdated versions of Python, so we need to install a recent Python 2 and 3 first. The recommended way of doing this is with the packet manager homebrew. To install homebrew, we need to open a Terminal and execute the following command:
```
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
The homebrew installer asks you to install the command line developer tools for “xcode-select”. Install them. When you are done, go back to the terminal and press Enter so that the installer continues.

If this doesn’t work for you, you’ll find more detailed instructions in the homebrew wiki.

Once the installation is successful, we can install python and python3:
```
$ brew install python python3
```
This will also install the Python package manager pip.
Next, we need virtualenv which can create isolated Python environments for different projects:
```
$ pip install -U virtualenv
```
Now we need to create a virtual environment for mosaik and its dependencies. The common location for venvs is under ~/.virtualenvs/:
```
$ virtualenv -p /usr/local/bin/python3 ~/.virtualenvs/mosaik
$ source ~/.virtualenvs/mosaik/bin/activate
```
Your command line prompt should now start with “(mosaik)” and roughly look like this: (mosaik)user@macbook:~$.
The final step is to install mosaik:
```
(mosaik)$ pip install mosaik
```
Mosaik should now be installed successfully.

Running the demo

Mosaik alone is not very useful (because it needs other simulators to perform a simulation), so we also provide a small demo scenario and some simple simulators as well as a mosaik binding for PYPOWER.

To clone the demo repository, we need to install git. In order to compile NumPy, SciPy and h5py (which are required by PYPOWER and the database adapter) we also need to install gfortran which is included in gcc. You should deactivate the venv for this:
```
(mosaik)$ deactivate
$ brew install git gcc hdf5
$ source ~/.virtualenvs/mosaik/bin/activate
```

For NumPy and SciPy we build binary wheel packages that we can later reuse without re-compiling everything. We’ll store these wheels in ~/wheelhouse/:

(mosaik)$ pip install wheel
(mosaik)$ pip wheel numpy
(mosaik)$ pip install wheelhouse/numpy-1.10.1-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
(mosaik)$ pip wheel scipy
(mosaik)$ pip install wheelhouse/scipy-0.16.0-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
(mosaik)$ pip wheel h5py
(mosaik)$ pip install wheelhouse/h5py-2.5.0-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl

Note

The file names of the wheels (*.whl-files) may change when version-numbers change. Please check the output of pip install or the directory ~/wheelhouse/ for the exact file names.

You can now clone the mosaik-demo repository into a folder where you store all your code and repositories (we’ll use ~/Code/):
```
(mosaik)$ mkdir ~/Code
(mosaik)$ git clone https://gitlab.com/mosaik/mosaik-demo.git ~/Code/mosaik-demo
```
Now we only need to install all requirements (mosaik and the simulators) and can finally run the demo:
```
(mosaik)$ cd ~/Code/mosaik-demo/
(mosaik)$ pip install -r requirements.txt
(mosaik)$ python demo.py
```
If no errors occur, the last command will start the demo. The web visualisation shows the demo in your browser: http://localhost:8000. You can click the nodes of the topology graph to show a time series of their values. You can also drag them around to rearrange them.

You can cancel the simulation by pressing Ctrl-C.

Windows

This guide is based on Windows 10, 64bit.

Mosaik and the demo scenario require Python >= 3.8. By default, it will offer you a 32bit installer. You can find the Windows x86-64 MSI installer here.
1. When the download finished, double-click the installer.
2. Select Install for all users and click Next >.
3. The default installation path is okay. Click Next >.
4. In the Customize Python page, click on the Python node and select Entire feature will be installed on local hard drive. Make sure that Add python.exe to Path is enabled. Click Next >.
5. When Windows asks you to allow the installation, allow the installation. Wait. Click Finish.
This also install the Python package manager pip.
We also need virtualenv which can create isolated Python environments for different projects.

Open a terminal window: Press the Windows key (or click on the start menu) and enter cmd. Press Enter. Your terminal prompt should look like C:\Users\yourname>. Execute the following command to install virtualenv:
```
C:\Users\yourname> pip install -U virtualenv
```
Note

If your Windows account type is Standard User, you need to open the terminal with administarator privileges (right-click the Terminal icon, then open as Administrator). Make then sure that you are in your user directory:
```
C:\Windows\system32> cd C:\Users\yourname
C:\Users\yourname>
```
Now we need to create a virtual environment for mosaik and its dependencies. The common location for venvs is under Envs/ in your users directory:
```
C:\Users\yourname> virtualenv -p path\to\python.exe Envs\mosaik
```
To activate the virtual environment use the following command:
```
C:\Users\yourname> Envs\mosaik\Scripts\activate
```
This command should also function when using the powershell, however the execution policy might need to be changed.

Your command line prompt should now start with “(mosaik)” and roughly look like this: (mosaik) C:\Users\yourname>.
The final step is to install mosaik:
```
(mosaik) C:\Users\yourname> pip install mosaik
```
Mosaik should now be installed successfully.

Running the demo

Mosaik alone is not very useful (because it needs other simulators to perform a simulation), so we also provide a small demo scenario and some simple simulators as well as a mosaik binding for PYPOWER.

Download and install git.

Restart the command prompt (as Admin if necessary and make sure you are in the right directory again) and activate the virtualenv again:
```
C:\Users\yourname> Envs\mosaik\Scripts\activate
```

Clone the demo repository:

(mosaik)C:\Users\yourname> git clone https://gitlab.com/mosaik/mosaik-demo.git

Now we only need to install all requirements (mosaik and the simulators) and can finally run the demo:
```
(mosaik)C:\Users\yourname> cd mosaik-demo
(mosaik)C:\Users\yourname\mosaik-demo> pip install -r requirements.txt
(mosaik)C:\Users\yourname\mosaik-demo> python demo.py
```
The web visualisation shows the demo in your browser: http://localhost:8000. You can click the nodes of the topology graph to show a timeline of their values. You can also drag them around to rearrange them.

You can cancel the simulation by pressing Ctrl-C. More exceptions may be raised. No problem. :-)