cartogram-web: Web-based Cartogram Generator

cartogram-web is a web-based tool designed to simplify the creation of contiguous cartograms. It provides a user-friendly, browser-based interface that makes cartogram creation accessible to a wider audience. You can use the tool online at https://go-cart.io.

This repository contains the source code behind the go-cart.io website. Users can input data through a streamlined interface, while a remote server performs fast flow-based cartogram calculations using a binary from mgastner/cartogram-cpp.

We recommend using go-cart.io for cartogram generation. However, if you want to run the tool locally, we suggest using go-cart-io/carotgram-docker.

Repository overview

This repository consists of three main folders:

• internal: Contains all pages of the site (e.g., home, cartogram, contact, etc.), written in Python.
• frontend: Contains interactive features of the site, written using Vue.js.
• tools: Contains utility tools that are not part of the site.

Updating the cartogram binary from mgastner/cartogram-cpp

To update the cartogram binary to:

• The latest available build on cartogram-cpp

  1. Run the following command:

  bash tools/pull-executable.sh --latest

• A specific release from cartogram-cpp

  1. Update /internal/executable/release-tag.txt with the desired release tag.
     • You may find the available releases here.
  2. Run the following command:

  bash tools/pull-executable.sh

Contributing

We welcome and encourage contributions! For details on setting up a development environment and contribution guidelines, please visit our Developer Guide.

Funding

Development of this software has been supported by the Ministry of Education, Singapore, under its Academic Research Fund Tier 2 (EP2) programme (Award No. MOE-T2EP20221-0007). The views expressed in this repository are those of the authors and do not necessarily reflect the views of the Ministry of Education, Singapore.