scout

A tool for estimating the future energy use, carbon emissions, and capital and operating cost impacts of energy efficiency and demand flexibility technologies in the U.S. residential and commercial building sectors.

https://github.com/trynthink/scout

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    2 of 15 committers (13.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.7%) to scientific vocabulary

Keywords

building-energy carbon-emissions demand-side-management energy-consumption energy-data energy-efficiency
Last synced: 9 months ago · JSON representation

Repository

A tool for estimating the future energy use, carbon emissions, and capital and operating cost impacts of energy efficiency and demand flexibility technologies in the U.S. residential and commercial building sectors.

Basic Info
  • Host: GitHub
  • Owner: trynthink
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage: https://scout.energy.gov
  • Size: 5.7 GB
Statistics
  • Stars: 68
  • Watchers: 10
  • Forks: 32
  • Open Issues: 103
  • Releases: 25
Topics
building-energy carbon-emissions demand-side-management energy-consumption energy-data energy-efficiency
Created over 11 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

scout Scout test status

The contents of this repository are all in-progress and should not be expected to be free of errors or to perform any specific functions. Use only with care and caution.

Scout is a software program that estimates the impacts of various energy conservation measures (ECMs) in the U.S. residential and commercial building sectors. Scout evaluates the energy savings, avoided CO2 emissions, operating cost reductions, and cost-effectiveness (using several metrics) of each ECM under multiple technology adoption scenarios. These results are obtained for the entire U.S., and also broken out by climate zone, building class (i.e., new/existing, residential/commercial), and end use.

Getting Started

Scout is currently a command line-based tool. Follow the Quick Start Guide to start using Scout on your computer.

Scout is free and open-source software and can be used by anyone, subject to the license terms.

Documentation

Documentation for Scout is available online. The documentation includes instructions for setting up a computer to run Scout, tutorials on how to use the components of Scout, a primer on the modeling approach, and reference materials for ECM definitions.

Future Updates

You can track on-going development of Scout in this repository. If you find any errors in the model or opportunities for improvement, contribute to the issue tracker by commenting on an existing issue or submitting a new one.

Scout Web App

The Scout web app allows users to review ECM definitions from the default portfolio in a convenient tabular format; visualize ECM impacts on energy, CO2 emissions, and operating costs for the default ECM portfolio; and query the baseline energy database.

Baseline Energy Calculator

The Baseline Energy Calculator is part of the Scout web app. It allows users to explore the Scout baseline data. Based on user selections, the calculator yields total baseline U.S. energy use and CO2 emissions for one or several energy use segments, which can help users evaluate the national impact potential for an ECM of interest.

Owner

  • Name: Chioke Harris
  • Login: trynthink
  • Kind: user
  • Company: @NREL

GitHub Events

Total
  • Create event: 63
  • Release event: 3
  • Issues event: 60
  • Watch event: 4
  • Delete event: 35
  • Issue comment event: 38
  • Push event: 355
  • Pull request event: 90
  • Pull request review comment event: 88
  • Pull request review event: 100
  • Fork event: 3
Last Year
  • Create event: 63
  • Release event: 3
  • Issues event: 60
  • Watch event: 4
  • Delete event: 35
  • Issue comment event: 38
  • Push event: 355
  • Pull request event: 90
  • Pull request review comment event: 88
  • Pull request review event: 100
  • Fork event: 3

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 939
  • Total Committers: 15
  • Avg Commits per committer: 62.6
  • Development Distribution Score (DDS): 0.414
Past Year
  • Commits: 88
  • Committers: 6
  • Avg Commits per committer: 14.667
  • Development Distribution Score (DDS): 0.568
Top Committers
Name Email Commits
Jared Langevin j****n@g****m 550
Chioke Harris t****k@g****m 243
aspeake1 a****e@n****v 88
AvenSM 3****y 17
GitHub Action g****n 16
Peter DeWitt p****t@c****u 7
handichan h****n@g****m 4
Robert Fares r****s@g****m 3
Valerie Nubbe v****e@g****m 3
Ardelia Clarke A****e@n****v 2
Jermy Thomas j****v@g****m 2
JLReyna j****a@n****v 1
carlobianchi89 c****i@u****u 1
lin l****n@n****v 1
Jermy Thomas j****3@n****v 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 327
  • Total pull requests: 254
  • Average time to close issues: 11 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 17
  • Total pull request authors: 13
  • Average comments per issue: 0.71
  • Average comments per pull request: 0.42
  • Merged pull requests: 133
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 44
  • Pull requests: 109
  • Average time to close issues: 23 days
  • Average time to close pull requests: 17 days
  • Issue authors: 4
  • Pull request authors: 5
  • Average comments per issue: 0.05
  • Average comments per pull request: 0.4
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • trynthink (143)
  • jtlangevin (126)
  • aspeake (23)
  • dewittpe (10)
  • asatremeloy (5)
  • jmythms (5)
  • briangerke (3)
  • suidi1990 (2)
  • zberquist (2)
  • thisIsMikeKane (1)
  • mcpigman (1)
  • joseph-robertson (1)
  • nfette (1)
  • lzavod (1)
  • bttrpntng (1)
Pull Request Authors
  • aspeake (85)
  • asatremeloy (44)
  • jtlangevin (30)
  • jmythms (29)
  • handichan (28)
  • trynthink (19)
  • dewittpe (7)
  • arb7 (4)
  • vnubbe (3)
  • lainsworth8801 (2)
  • robertfares (1)
  • carlobianchi89 (1)
  • axelstudios (1)
Top Labels
Issue Labels
database (79) enhancement (74) engine (44) measure (43) interface (36) bug (34) docs (24) calculator (22) functions (22) test needed (14) idea (11) refactoring (10) question (10) help wanted (9) ecm handling (7) web (3) invalid (2) testing (1) bss adoption feature (1)
Pull Request Labels
DO NOT MERGE (27) testing (2) refactoring (1)

Dependencies

docs/requirements.txt pypi
  • readthedocs-sphinx-search *
  • sphinx *
  • sphinx_rtd_theme *
.github/workflows/tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2 composite
  • actions/setup-python v2 composite
.github/workflows/integration_tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • aws-actions/configure-aws-credentials v2 composite
  • machulav/ec2-github-runner v2 composite