National Household Model
Source: data.gov.uk (2017-10-30)

The National Household Model (NHM) is delivered by the Department for Business, Energy and Industrial Strategy (BEIS). It was developed on behalf of BEIS by the Centre for Sustainable Energy (CSE) as an open-source tool for projecting the effects of policy and other legislative changes on the energy and emissions of the UK domestic housing stock by the Department of Energy and Climate Change (DECC).  In order to be able to set up scenarios model users need to learn a specialist scenario language based on S-expressions (such as those used in the Lisp language) using the instruction manual found on the BEIS GitHub site.  This will allow them to run the model which acts on the data in the various UK housing surveys. UK Data Archive stores the datasets for this model on behalf of the Department for Communities and Local Government (DCLG). Users need to register at UK Data Archive in order to access the raw data and run a conversion program to create a full dataset. The NHM team encourages feedback on all aspects of the model and documentation.

Navigation Menu

GitHub CopilotWrite better code with AI

GitHub SparkBuild and deploy intelligent apps

GitHub ModelsManage and compare prompts

MCP RegistryNewIntegrate external tools

ActionsAutomate any workflow

CodespacesInstant dev environments

IssuesPlan and track work

Code ReviewManage code changes

GitHub Advanced SecurityFind and fix vulnerabilities

Code securitySecure your code as you build

Secret protectionStop leaks before they start
- Why GitHub (https://github.com/why-github)
- Documentation (https://docs.github.com)
- Blog (https://github.blog)
- Changelog (https://github.blog/changelog)
- Marketplace (https://github.com/marketplace)
View all features (https://github.com/features)
- Enterprises (https://github.com/enterprise)
- Small and medium teams (https://github.com/team)
- Startups (https://github.com/enterprise/startups)
- Nonprofits (https://github.com/solutions/industry/nonprofits)
- App Modernization (https://github.com/solutions/use-case/app-modernization)
- DevSecOps (https://github.com/solutions/use-case/devsecops)
- DevOps (https://github.com/solutions/use-case/devops)
- CI/CD (https://github.com/solutions/use-case/ci-cd)
- View all use cases (https://github.com/solutions/use-case)
- Healthcare (https://github.com/solutions/industry/healthcare)
- Financial services (https://github.com/solutions/industry/financial-services)
- Manufacturing (https://github.com/solutions/industry/manufacturing)
- Government (https://github.com/solutions/industry/government)
- View all industries (https://github.com/solutions/industry)
View all solutions (https://github.com/solutions)
- AI (https://github.com/resources/articles?topic=ai)
- Software Development (https://github.com/resources/articles?topic=software-development)
- DevOps (https://github.com/resources/articles?topic=devops)
- Security (https://github.com/resources/articles?topic=security)
- View all topics (https://github.com/resources/articles)
- Customer stories (https://github.com/customer-stories)
- Events & webinars (https://github.com/resources/events)
- Ebooks & reports (https://github.com/resources/whitepapers)
- Business insights (https://github.com/solutions/executive-insights)
- GitHub Skills (https://skills.github.com)
- Documentation (https://docs.github.com)
- Customer support (https://support.github.com)
- Community forum (https://github.com/orgs/community/discussions)
- Trust center (https://github.com/trust-center)
- Partners (https://github.com/partners)
GitHub SponsorsFund open source developers
- Security Lab (https://securitylab.github.com)
- Maintainer Community (https://maintainers.github.com)
- Accelerator (https://github.com/accelerator)
- Archive Program (https://archiveprogram.github.com)
- Topics (https://github.com/topics)
- Trending (https://github.com/trending)
- Collections (https://github.com/collections)
Enterprise platformAI-powered developer platform

GitHub Advanced SecurityEnterprise-grade security features

Copilot for BusinessEnterprise-grade AI features

Premium SupportEnterprise-grade 24/7 support
- Pricing (https://github.com/pricing)
Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation (https://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax).

Cancel Create saved search

Sign in (/login?return_to=https%3A%2F%2Fgithub.com%2FUKGovernmentBEIS%2Fnational-household-model-core-components)

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

UKGovernmentBEIS (/UKGovernmentBEIS) / national-household-model-core-components (/UKGovernmentBEIS/national-household-model-core-components) Public
- Notifications (/login?return_to=%2FUKGovernmentBEIS%2Fnational-household-model-core-components) You must be signed in to change notification settings
- Fork 1 (/login?return_to=%2FUKGovernmentBEIS%2Fnational-household-model-core-components)
Star 4 (/login?return_to=%2FUKGovernmentBEIS%2Fnational-household-model-core-components)

4 stars (/UKGovernmentBEIS/national-household-model-core-components/stargazers) 1 fork (/UKGovernmentBEIS/national-household-model-core-components/forks) Branches (/UKGovernmentBEIS/national-household-model-core-components/branches) Tags (/UKGovernmentBEIS/national-household-model-core-components/tags) Activity (/UKGovernmentBEIS/national-household-model-core-components/activity)

Star (/login?return_to=%2FUKGovernmentBEIS%2Fnational-household-model-core-components)

Notifications (/login?return_to=%2FUKGovernmentBEIS%2Fnational-household-model-core-components) You must be signed in to change notification settings
- Code (/UKGovernmentBEIS/national-household-model-core-components)
- Issues 1 (/UKGovernmentBEIS/national-household-model-core-components/issues)
- Pull requests 0 (/UKGovernmentBEIS/national-household-model-core-components/pulls)
- Actions (/UKGovernmentBEIS/national-household-model-core-components/actions)
- Projects 0 (/UKGovernmentBEIS/national-household-model-core-components/projects)
Uh oh!

There was an error while loading. Please reload this page.
- Insights (/UKGovernmentBEIS/national-household-model-core-components/pulse)
- Code (/UKGovernmentBEIS/national-household-model-core-components)
- Issues (/UKGovernmentBEIS/national-household-model-core-components/issues)
- Pull requests (/UKGovernmentBEIS/national-household-model-core-components/pulls)
- Actions (/UKGovernmentBEIS/national-household-model-core-components/actions)
- Projects (/UKGovernmentBEIS/national-household-model-core-components/projects)
- Security (/UKGovernmentBEIS/national-household-model-core-components/security)
- Insights (/UKGovernmentBEIS/national-household-model-core-components/pulse)
UKGovernmentBEIS/national-household-model-core-components

master

Branches (/UKGovernmentBEIS/national-household-model-core-components/branches)Tags (/UKGovernmentBEIS/national-household-model-core-components/tags)

(/UKGovernmentBEIS/national-household-model-core-components/branches) (/UKGovernmentBEIS/national-household-model-core-components/tags)

Go to file

Open more actions menu

Folders and files

Last commit message

Last commit date

Latest commit

History

(/UKGovernmentBEIS/national-household-model-core-components/commits/master/)

core-projects (/UKGovernmentBEIS/national-household-model-core-components/tree/master/core-projects)

core-projects (/UKGovernmentBEIS/national-household-model-core-components/tree/master/core-projects)

nhm-documentation (/UKGovernmentBEIS/national-household-model-core-components/tree/master/nhm-documentation)

nhm-documentation (/UKGovernmentBEIS/national-household-model-core-components/tree/master/nhm-documentation)

nhm-ide (/UKGovernmentBEIS/national-household-model-core-components/tree/master/nhm-ide)

nhm-ide (/UKGovernmentBEIS/national-household-model-core-components/tree/master/nhm-ide)

p2 (/UKGovernmentBEIS/national-household-model-core-components/tree/master/p2)

p2 (/UKGovernmentBEIS/national-household-model-core-components/tree/master/p2)

system-tests (/UKGovernmentBEIS/national-household-model-core-components/tree/master/system-tests)

system-tests (/UKGovernmentBEIS/national-household-model-core-components/tree/master/system-tests)

.editorconfig (/UKGovernmentBEIS/national-household-model-core-components/blob/master/.editorconfig)

.editorconfig (/UKGovernmentBEIS/national-household-model-core-components/blob/master/.editorconfig)

.gitignore (/UKGovernmentBEIS/national-household-model-core-components/blob/master/.gitignore)

.gitignore (/UKGovernmentBEIS/national-household-model-core-components/blob/master/.gitignore)

.gitmodules (/UKGovernmentBEIS/national-household-model-core-components/blob/master/.gitmodules)

.gitmodules (/UKGovernmentBEIS/national-household-model-core-components/blob/master/.gitmodules)

README.md (/UKGovernmentBEIS/national-household-model-core-components/blob/master/README.md)

README.md (/UKGovernmentBEIS/national-household-model-core-components/blob/master/README.md)

build.sh (/UKGovernmentBEIS/national-household-model-core-components/blob/master/build.sh)

build.sh (/UKGovernmentBEIS/national-household-model-core-components/blob/master/build.sh)

default.nix (/UKGovernmentBEIS/national-household-model-core-components/blob/master/default.nix)

default.nix (/UKGovernmentBEIS/national-household-model-core-components/blob/master/default.nix)

maven-settings.xml (/UKGovernmentBEIS/national-household-model-core-components/blob/master/maven-settings.xml)

maven-settings.xml (/UKGovernmentBEIS/national-household-model-core-components/blob/master/maven-settings.xml)

release.sh (/UKGovernmentBEIS/national-household-model-core-components/blob/master/release.sh)

release.sh (/UKGovernmentBEIS/national-household-model-core-components/blob/master/release.sh)

View all files

Repository files navigation
- README (#)
Synopsis

The repository holds the repositories required to build the core components for the National Household Model (NHM), the components include projects to define the properties and actions a Survey Case has within the model, projects to compile and execute scenarios as a simulation, projects that define the actions and measures than can can be applied within a simulation and code to import a housing stock to run simulations on.

If you would like to run a compiled version of the National Household Model, releases of the application can be found here (https://github.com/UKGovernmentBEIS/national-household-model-core-components/releases) or by clicking on 'Releases' above.

The project has been written using Java 1.7, will shortly be java 1.8.

Installation

This is a bit basic, we will fill in later, the project can be built end-to-end on a linux machine.

Dependencies
- A JDK for Java 7 or above
- The bash shell
- Maven
- Gradle
- xmlstarlet
- webfsd
- R and packages
You can assemble all the dependencies you need using nixpkgs. Install this, and run the build inside a shell produced with nix-shell user-environment.nix.

Building

A complete build can be run using the script build.sh in the top-level directory. Invoke ./build --help for more on how to use it.

The script uses other build tools to run various build stages. A summary follows but the script itself should be good documentation, so read that if you want to know what's going on.

Building the core model

This is all in core-projects and is built using gradle. This is sufficient to produce a working copy of the model usable on the command line

Generating the documentation

This is in nhm-documentation, and depends on the core model being built first as this generates some of the documentation text. It's built with maven, using a docbook plugin.

Building the IDE

This is in nhm-ide; it has a couple of steps:
- Collect up all the model versions into the p2/inputs folder. Any newly built jars are taken from the binaries/ folder and put in here.
- Use the maven tycho p2 extras plugin to assemble a p2 repository for these jars.
- Run webfsd to serve the p2 repository locally via http on port 8000
- Use maven tycho to compile the NHM application 'product'
Running the system tests

These are in system-tests; they involve running a bunch of scenarios against the model CLI and then verifying the results with some simple R scripts.

Packaging a result for distribution

The build script can locate all the things you need to run the application, including copies of the model for use on a back-end server if you have one.

Doing a release

We try and derive version numbers from git where possible, but this is not easy for the maven parts of the project. The release script should help you bump all the version numbers and end up with something usable.

It is run through build.sh so don't run it on its own.

License

[Open Government License] (http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)

About

No description, website, or topics provided.

Resources

Readme (#readme-ov-file)

Uh oh!

There was an error while loading. Please reload this page.

Activity (/UKGovernmentBEIS/national-household-model-core-components/activity)

Custom properties (/UKGovernmentBEIS/national-household-model-core-components/custom-properties)

Stars

4 stars (/UKGovernmentBEIS/national-household-model-core-components/stargazers)

Watchers

5 watching (/UKGovernmentBEIS/national-household-model-core-components/watchers)

Forks

1 fork (/UKGovernmentBEIS/national-household-model-core-components/forks)

Report repository (/contact/report-content?content_url=https%3A%2F%2Fgithub.com%2FUKGovernmentBEIS%2Fnational-household-model-core-components&report=UKGovernmentBEIS+%28user%29)

Releases 3 (/UKGovernmentBEIS/national-household-model-core-components/releases)

Version 7.2.2 Latest

Feb 13, 2019

+ 2 releases (/UKGovernmentBEIS/national-household-model-core-components/releases)

Packages 0 (/orgs/UKGovernmentBEIS/packages?repo_name=national-household-model-core-components)

No packages published

Contributors 5 (/UKGovernmentBEIS/national-household-model-core-components/graphs/contributors)

Uh oh!

There was an error while loading. Please reload this page.

Languages
- Java 94.4% (/UKGovernmentBEIS/national-household-model-core-components/search?l=java)
- Assembly 3.6% (/UKGovernmentBEIS/national-household-model-core-components/search?l=assembly)
- HTML 1.2% (/UKGovernmentBEIS/national-household-model-core-components/search?l=html)
- JavaScript 0.3% (/UKGovernmentBEIS/national-household-model-core-components/search?l=javascript)
- R 0.3% (/UKGovernmentBEIS/national-household-model-core-components/search?l=r)
- Shell 0.1% (/UKGovernmentBEIS/national-household-model-core-components/search?l=shell)
- Other 0.1%
Footer

(https://github.com) © 2026 GitHub, Inc.

Footer navigation
- Terms (https://docs.github.com/site-policy/github-terms/github-terms-of-service)
- Privacy (https://docs.github.com/site-policy/privacy-policies/github-privacy-statement)
- Security (https://github.com/security)
- Status (https://www.githubstatus.com/)
- Community (https://github.community/)
- Docs (https://docs.github.com/)
- Contact (https://support.github.com?tags=dotcom-footer)
- Manage cookies
- Do not share my personal information
You can’t perform that action at this time.