Spatial Microsimulation Urban Metabolism Model (SMUM)

This is the main repository for the developing of the Spatial Microsimulation Urban Metabolism (SMUM) model.

The model is currently under development.

Check back for an update on its deployment.

If you want to run the model locally please use the docker image.

Install

To install the python library only via pip.

pip install -e git+https://github.com/emunozh/smum.git#egg=smum

Using the Docker image

Currently the docker images are build automatically with each new github push. This means that you need to be careful with the version you are using, make sure that the main python library code is passing all test on travis.

The model has been developed to run on a server, and therefor developed to run on linux, below you will find setup instruction for installing and running the model on a linux server and an untested instruction on how to do in on a windows machine.

Linux

# Install docker if you don't have it via your favorite pakage manager
sudo pacman -Ss docker

# Make sure docker is runing
systemctl status docker
# Start docker service
systemctl start docker

# Pull docker image
# Be patient the image is big
docker pull emunozh/smum

# Run the model
docker run -it -p 8080:8080 emunozh/smum

# Lunch jupyterhub within docker container
jupyterhub --ip=0.0.0.0

You can build the docker image locally for testing and debugging.

# Build the docker image on your computer
# Clone github repository
git clone git@github.com:emunozh/smum.git

# Move to um folder
cd um

# Build docker image
docker build . -t smum

# Run docker image
docker run -it smum

# Lunch jupyterhub
jupyterhub --ip=0.0.0.0

Windows

Caution!

NOT TESTED!

The installation process should be simple:

1. Install Docker for Windows
2. Pull the docker image docker pull emunozh/smum
3. Run the docker container docker run -it -p 8080:8080 emunozh/smum
4. Lunch the Jupyterhub server jupyterhub --ip=0.0.0.0
5. Open your browser at http://0.0.0.0:8080

Contribute

• Issue Tracker: github.com/emunozh/smum/issues
• Source Code: github.com/emunozh/smum

Support

If you are having issues, please let us know.

License

The project is licensed under the GPL-3.0 license.