Welcome to Pearl Certification’s documentation!

Pearl Home Certification | Pearl :: Home Energy Efficiency Certification Program

Project Overview

• 1. Overview
• 2. Release Workflow
  • 2.1. Prerequisites
  • 2.2. Workflow
  • 2.3. The second reviewer
  • 2.4. Meetings in a release lifetime
• 3. Development Workflow
  • 3.1. Jira Workflow
  • 3.2. GitFlow:

Getting Started

• 1. Setup Project
  • 1.1. Prerequisites:
  • 1.2. Steps to create the Dev Env:
  • 1.3. Notes about running the project:
  • 1.4. Dumping data into database with vagrant:
  • 1.5. Notes about the setup:
• 2. Working with Multiple Databases
  • 2.1. Process for setting up the RESNET db from scratch
  • 2.2. Process for working with multiple databases
• 3. Code Quality
  • 3.1. Black
  • 3.2. Flake8
  • 3.3. Djhtml
  • 3.4. Steps to setup pre-commit hooks
• 4. Celery
  • 4.1. Creating Celery tasks:
  • 4.2. Current Celery Setup
  • 4.3. Celery Beat
  • 4.4. Celery for local development
  • 4.5. Celery for Staging and Production
• 5. Steps to create homes with the automated flow
  • 5.1. Lennox Report Changes:
  • 5.2. Steps to upload home using the automated flow:

Development Recipes

• 1. Pearl API Versioning
  • 1.1. Audit API changes
  • 1.2. Changes included v6.2
  • 1.3. Changes included v6.1
  • 1.4. Changes included v6
  • 1.5. Changes included v5
  • 1.6. Changes included v4.2
  • 1.7. Changes included v4.1
  • 1.8. Changes included v4
  • 1.9. Changes included v3
  • 1.10. Changes included v2
  • 1.11. Changes included in v1.1
• 2. Implementing scoring changes
• 3. Steps to Add new Asset and Asset Category
• 4. RE market state addition steps
• 5. Steps to Add new MLS
• 6. Steps to Add a new asset to the Snapshot data
• 7. Steps to Add a new question to the asset inventory
  • 7.1. Checklist for adding/removing/updating a question in the asset inventory
  • 7.2. Sample detailed scenario of adding a new question to the asset inventory
  • 7.3. Add a new asset characteristic based on the new question to the Certification Report (CR)
  • 7.4. Add the new question to AI Addendum
• 8. Steps to add a new HIP Asset
• 9. Automate deployment using runscripts management command
  • 9.1. Overview:
  • 9.2. Adding a new script to be run:
• 10. Updating Project Requirements
  • 10.1. Steps for updating project dependencies
  • 10.2. Steps for adding a new package
  • 10.3. Steps for removing a package
  • 10.4. Few notes around package upgrades

Refactoring/Enhancements

• 1. Small Items
• 2. Bigger Items
  • 2.1. Setup Tests
  • 2.2. Outstanding tasks
  • 2.3. Scoring
  • 2.4. Writing Tests
  • 2.5. Staging Deployment

Testing

• 1. Getting Started
  • 1.1. About Running Tests
  • 1.2. About Writing Tests
  • 1.3. Note about scoring tests in case of any change in question options
  • 1.4. Update DB dump to speed up test db creation

About documentation

• 1. Writing documentation
  • 1.1. Getting started with Sphinx
  • 1.2. Configure Sphinx with Pearl Project
  • 1.3. References