Home

Welcome to the Colouring Cities Technical Manual.

This wiki is intended as a centralised repository of all the technical information that research software engineers will need to know about Colouring Cities (CCRP) and its core code, and how to get started with your own Colouring Cities platform. The Manual is being collaboratively developed across countries by research software engineers involved in the research programme

How the CCRP Network works

An introduction to the CCRP Platform network.

• How does the Colouring Cities system work?
• Codes of Conduct
• Ethical Framework
• CCRP RSE protocols
• Recommended Protocols and Best Practices
• Open Licences

CCRP International RSE Group

Information on current and past CCRP research software engineers and RSE job specs.

• Who's involved?
• Technical History 2017‐
• RSE job spec & tips for creating sustainable teams
• RSE Group Monthly meetings

GitHub

We use GitHub as our main platform for managing the CCRP.

• GitHub Organisational Structure
• GitHub Accounts

CCRP Onboarding

We have an onboarding process for new Colouring Cities Platform partners joining the project. The Turing team will set up everything on GitHub, including creating a fork of the Core platform and adding users to a Team, so they have access to everything they need to get started. We can also create demo videos for you, see below.

• Onboarding process

Platform Setup and Deployment

The CCRP currently offers two options to help you get started with the Colouring Cities platform.

• Partners can set up the platforms themselves. We recommend doing this, if possible, as a way to introduce engineers to the platform and how it works.
• Alternatively, we can help get the platform ready to use, if you provide us with access to open building footprints and the server/virtual machine where the platform will be hosted.

We have created step-by-step instructions for setting up the platform, including information on Domain Names and building footprints.

Troubleshooting

Guides to support Colouring Cities platform development and how to fix some common issues.

• Troubleshooting common issues

New features in development

Information on new technical features being worked on within or across countries.

• Feedback loops between data capture methods
• Automatic verification of academic emails
• Data Model second-stage development
• Translation Tools
• Mobile functionality/interface
• Bulk upload tool
• Showcase Section
• Global database search facility
• CCRP International Webpage and Dashboard

Demo Video Development

We have tolls, templates and support for creating demo videos of your Colouring Cities platform.

• Demo video development