Skip to content

Project Structure

Jump to bottom
Stephen Frank edited this page Nov 18, 2013 · 5 revisions

Project Structure

For both developers and end users, the Campus Energy Modeling project is organized within the following file and directory structure:

  • Demo/ contains demonstration models
  • Library/ contains the Simulink block library and MATLAB utility functions
    • databus2matlab/ contains the DataBus to MATLAB utility functions
    • simulink/ contains the Simulink library, S-functions, and block mask callback functions
    • ssc2matlab/ contains the SSC to MATLAB utility functions
    • utility/ contains general purpose utility functions
  • MLEP/ contains a customized build of MLE+ for use with the library (see Installation)
  • Test/ contains a suite of automated test scripts
  • .gitignore is the master Git ignore file for the project
  • Changes.md contains the project change log
  • install.m is the project installation script
  • README.md and README.txt are markdown and plain text versions of the project README, respectively
  • ReleaseNotes.md contains release notes for the current release

The MLEP directory is temporary and will be removed once the official release of MLE+ adequately supports the Campus Energy Modeling project. The other files and directories are described below.

Demo

Each subdirectory within the Demo directory contains all required files for a single demonstration model. See Creating Demos for development guidance.

Library

The Library directory contains the Simulink block models, S-functions, MATLAB utility functions, and all other required files which must be on the MATLAB path. See Developing Models and Developing Functions for development guidance.

Test

The Test directory contains test data and automated test scripts. See Testing for details and development guidance.

Installation Script

The installation script install.m saves the necessary directories within Library to the MATLAB path to grant access to the Campus Energy Modeling Simulink block library and MATLAB utility scripts. Modify this script with caution!

At present, install.m also installs a customized version of MLE+ (located in the MLEP directory) by calling the MLE+ installation script. This part of the installation will be removed once the official release of MLE+ adequately supports the Campus Energy Modeling project.

Git Ignore

The .gitignore file in the root directory specifies Git's default ignore settings for the entire project. It has been tailored to ignore most files that are automatically generated by MATLAB, Simulink, and the other modeling tools associated with the project. Some other subdirectories in the project contain their own supplemental .gitignore files based on the need to version control specific file types in certain locations. An example is Library/simulink/graphics/, within which Git does not ignore graphics files (unlike elsewhere in the project).

Change Log

The change log Changes.md documents all significant changes between adjacent releases of the project. See Workflow for details.

README

The README files provides a brief description of the project and links to the online documentation. There are two versions of README:

  • README.md, a markdown version which displays automatically on GitHub, and
  • README.txt, a plain text version for offline viewing.

The two files contain identical content and should be maintained in parallel.

Release Notes

The release notes in ReleaseNotes.md highlight significant aspects of the current release. See Workflow for details.

Clone this wiki locally