Developer walkthrough

Contents

• Configuration File Details
  • Overview
  • Initialization of the config object
  • How a value is read from the config file
  • How a value is saved to the config file
  • How to create new parameter types
• User Interfaces
  • The Command Line Interface
• Architecture
  • Demand calculation
  • InputLocator
  • Analysis and Visualization
  • “Higher order” modules
• How to review a pull request
  • 1. Read the PR description and follow the test
  • 2. Go through the file changes
  • 3. Run tests
  • 4. Merge the Pull Request
• How to add a heating/cooling system in CEA
  • Step 0: Make an issue and create a branch
  • Step 1: Add the new system to the database
  • Step 2: Add the new system to the options
  • Step 3: Add a new function to model new technologies
  • Step 3: Add a new function to calculate cooling/heating loads
  • Step 4: Add distribution losses
  • Step 5: Calculate temperature and mass flow primary supply systems
  • Step 6: Calculate auxiliary electricity
• Data description for thermal_network_matrix.py
  • ThermalNetwork.buildings_demands
  • ThermalNetwork.substations_HEX_specs
  • ThermalNetwork.t_target_supply_C
  • T_substation_supply_K
  • ThermalNetwork.t_target_supply_df
  • ThermalNetwork.all_nodes_df
  • ThermalNetwork.edge_df
  • ThermalNetwork.edge_node_df
  • ThermalNetwork.edge_mass_flow_df
  • ThermalNetwork.node_mass_flow_df
  • T_return_all
  • mdot_all
  • required_flow_rate_df
  • max_edge_mass_flow_df
  • ThermalNetwork.pipe_properties
• Description of DataFrames and Lists written to csv by the thermal_network_matrix.py file
  • csv_outputs[‘T_supply_nodes’]
  • csv_outputs[‘T_return_nodes’]
  • csv_outputs[‘q_loss_supply_edges’]
  • csv_outputs[‘plant_heat_requirement’]
  • csv_outputs[‘pressure_nodes_supply’]
  • csv_outputs[‘pressure_nodes_return’]
  • csv_outputs[‘pressure_loss_system_Pa’]
  • csv_outputs[‘pressure_loss_system_kW’]
  • csv_outputs[‘pressure_loss_supply_kW’]
  • csv_outputs[‘q_loss_system’]
  • csv_outputs[‘edge_mass_flows’]
• How to create a new release?
  • Versioning
  • Create a Release Branch
  • Update the CREDITS.md file
  • Update CHANGELOG
  • Updating the CEA GUI interface
  • Creating the installer
  • Create a Release Draft on GitHub
  • Testing in a virtual machine
  • Merge the Release Branch
  • Publish the Release on GitHub
  • Building the documentation
  • Updating Link in www.cityenergyanalyst.com/try-cea
  • Uploading to PyPI
• How to set up the Jenkins server on a new PC
  • Installation of some prerequisites
  • Installation of Jenkins
  • Installation of a tunnel to the Jenkins server
  • Global configuration of Jenkins
  • Configuration of the Jenkins items
• Running the CEA in Docker
  • Building the image
  • Pull docker image
  • Running the image in a new container
• How to clean up CEA git repository
  • CEA Git Repository
  • Cleaning up the Repository
  • Adding additional files to clean from history
• Access CEA using the Pycharm Interface