Repository: IRIS-visualisation
Description: This repository functions as the client side of IRIS and contains front-end views and logic.
SPDX-License-Identifier: Apache-2.0 AND OGL-UK-3.0
The code previously maintained in this repository has been migrated to the IRIS monorepo.
The current and actively maintained source code is available at:
https://github.com/National-Digital-Twin/IRIS
This repository is retained to preserve the history of earlier public releases but will no longer receive updates.
IRIS is a digital tool designed to support data-driven decision-making for retrofitting domestic properties by identifying homes that could benefit from energy efficiency improvements. It enables stakeholders to assess housing stock based on energy performance data to help target funding schemes and policy interventions more effectively. IRIS is part of the NDTP Demonstrator Programme.
This repository contains the front-end logic for IRIS, allowing the user to visualise property and EPC data.
Before using this repository, ensure you have the following dependencies installed:
- Required Tooling: NVM, Angular CLI
- System Requirements: Dual-Core CPU (Intel i5 or AMD Ryzen 3 equivalent), 8GB RAM, SSD/HDD with 10GB free space
Follow these steps to get started quickly with this repository. For detailed installation, configuration, and deployment, refer to the relevant MD files.
git clone https://github.com/IRIS-visualisation.git
cd IRIS-visualisationIt is recommended to use nvm to manage versions of node, this project has been setup with an .nvmrc file so make sure to install and use this;
nvm install
nvm use
Create a personal access token on GitHub - https://github.com/settings/tokens - create a classic token with read:packages permission store this safely and make sure to add as an environment variable;
export GITHUB_ACCESS_TOKEN=ghp_xxxxxxx
You should now be able to run the usual install
npm install
Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
Refer to INSTALLATION.md for detailed installation steps, including required dependencies and setup configurations.
For steps to remove this repository and its dependencies, see UNINSTALL.md.
Include a brief list of key features provided by this repository. These should highlight what makes the project valuable to users and contributors. Examples of features might include:
- Core functionality Allows the visualisation of housing data on a map interface including materials + EPC ratings.
- Scalability & performance Code optimised for scalability and performance.
This repository has been developed with public funding as part of the National Digital Twin Programme (NDTP), a UK Government initiative. NDTP, alongside its partners, has invested in this work to advance open, secure, and reusable digital twin technologies for any organisation, whether from the public or private sector, irrespective of size.
This repository contains both source code and documentation, which are covered by different licenses:
- Code: Originally developed by Ove Arup & Partners, and Informed Solutions, now maintained by National Digital Twin Programme. Licensed under the Apache License 2.0.
- Documentation: Licensed under the Open Government Licence v3.0.
See LICENSE.md, OGL_LICENCE.md, and NOTICE.md for details.
We take security seriously. If you believe you have found a security vulnerability in this repository, please follow our responsible disclosure process outlined in SECURITY.md.
We welcome contributions that align with the Programme’s objectives. Please read our CONTRIBUTING.md guidelines before submitting pull requests.
This repository has benefited from collaboration with various organisations. For a list of acknowledgments, see ACKNOWLEDGEMENTS.md.
For questions or support, check our Issues or contact the NDTP team on ndtp@businessandtrade.gov.uk.
Maintained by the National Digital Twin Programme (NDTP).
© Crown Copyright 2025. This work has been developed by the National Digital Twin Programme and is legally attributed to the Department for Business and Trade (UK) as the governing entity.