README.md

ETMoses

This is the source code of ETMoses: an online decision support tool to create local energy situations for neighbourhoods, cities and regions with a time resolution of 15 minutes. This software is Open Source, so you can fork it and alter at your will.

If you have any questions, please contact us.

Documentation

• User documentation for ETMoses can be found on the ETM documentation repository
• Technical documentation is located on the ETMoses Wiki page.
• A PDF document describing the ideas and choices behind the modeling of ETMoses can be downloaded here.

Build Status

Master

Production

License

ETMoses is released under the MIT License.

Branches

• master: Working branch. Please always merge pull requests with this branch, just like any other Git project This branch is automatically deployed to the ETMoses staging server.
• production: Tracks the ETMoses production server

Dependencies

• Git
• Ruby 2.0+
• Bundler
• MySQL database server

Installing

• Install ImageMagick

  • Mac: brew install imagemagick
  • Ubuntu: sudo apt-get install imagemagick libmagickwand-dev

• Pull this repository with git clone [email protected]:quintel/etmoses.git

• Create your personal configuration files from the samples with

  cp -vn config/database.sample.yml config/database.yml
  cp -vn config/secrets.sample.yml config/secrets.yml
  cp -vn config/email.sample.yml config/email.yml
  

• Provide your MySQL username/password to config/database.yml if it is different from root/blank

• Run bundle install to install all the dependencies

• Create local database with bundle exec rake db:create

• Fill database structure and seeds with bundle exec rake db:reset

• Copy load profiles, technologies etc from staging server

  • Run bin/sync_profiles
  • Clone staging database to local development database

• If you need to connect to a local ETEngine server rather than the staging server, copy config/settings.yml to config/settings.local.yml and adapt settings accordingly

• Fire up your local server with bundle exec rails server -p3000

• Go to localhost:3000 and you should see ETMoses

Bugs and feature requests

If you encounter a bug or if you have a feature request, you can either let us know by creating an Issue or you can try to fix it yourself and create a pull request.