Skip to content

cse-bristol/energy-efficiency-planner

Repository files navigation

Energy Efficiency Planner

A web-based mapping tool. Use it to plan an energy intervention in an area, then share that plan with local stakeholders. Create your own alternative versions of plans which have been shared.

Features

  • Import shapes onto a map by dragging and dropping geoJSON, topoJSON or Shapefile, along with data describing attributes of those shapes as tsv.
  • View the data associated with the shapes in a table.
  • Colour the shapes on the map according to the data.

Source Code

Get the source code.

Installation

Clone the repository.

git clone git@github.com:cse-bristol/energy-efficiency-planner.git;

Optionally, check out a release. These are implemented as git tags:

git fetch -a;
git checkout v0.5.0;

Build the Code

Our Javascript files are arranged as node.js modules, and we use the ‘browserify’ tool to combine them into a single file.

Begin by installing Node JS. On a Debian-based system, I’d recommend using this PPA:

sudo add-apt-repository ppa:chris-lea/node.js 
sudo aptitude update
sudo aptitude install -y nodejs

Then run the following:

git submodule update --init; # Acquire external libraries which aren't currently available as npm modules.
npm -g install browserify; # Install Browserify as a command you can run.
npm install; # Install the various packages we depend on (listed in package.json).
browserify glue.js -o bin/main.js; # Package all the Javascript code together in a way that we can load into a browser.

Serve as a web site

Serve using any web server, for example using python3 on a Debian system:

sudo python3 -m http.server 80 &

Future Plans

See TODO.org.

About

A web-based map for collaborating on developing energy plans.

Resources

License

Stars

Watchers

Forks

Packages

No packages published