Development Guide

Introduction

The Campus Energy Modeling project seeks to provide an easy to use integrated environment for energy modeling at a campus scale. To this end, we focus on creating:

1. Seamless interfaces among modeling tools;
2. Simple, user-friendly functions and Simulink blocks; and
3. Clear and comprehensive documentation.

To facilitate these outcomes, we have standard practices, templates, and an organizational structure for the project. These are outlined in our our development guide:

• Using Git - Instructions for developing code using Git
• Workflow - Describes of our standard Git workflow, including instructions for third party developers
• Project Structure - Outlines the project directory structure
• Developing Models - Instructions for developing Simulink models
• Developing Functions - Instructions for developing MATLAB utility functions
• Testing the Library - Instructions for developing and running automated test scripts
• Creating Demos - Instructions for creating demonstration models
• Writing Documentation - Guidelines for writing project documentation
• Technical Resources - For NREL staff, how to access additional technical resources

When contributing code or documentation, please abide by the guidelines in these wiki pages. Thank you for being a developer!