Metadata-Version: 2.2
Name: costmodel
Version: 0.2.0
Summary: A cost model application with a Flask web interface.
Home-page: https://github.com/
Author: Edward Honadel and Peter Sandborn
Author-email: ehonadel@umd.edu
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Flask
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: flask
Requires-Dist: matplotlib
Requires-Dist: plotly
Requires-Dist: pandas



  

  

# MOSTCOOL

  

## Requirements/Tested on:

  

1. Ubuntu 22.04 with administrator access (Also works on Virtual Machines).

  

2. At least Quad Core CPU

  

3. At least 16 GB RAM

  

4. At least 4 GB hard disk space

  

  

## How to run:

  

  

1. Install docker in your computer:

  

https://docs.docker.com/engine/install/

  

  

2. Clone this repo:

  

`git clone --branch cost-model https://github.com/NREL/CoolerChips.git`

  

  

3. cd into the cloned directory.

  

4. Download required dependencies and place them in these paths:

  

  
  


| File Name            | Link                                                                                          | Place in this path in local directory                          |
|----------------------|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------|
| modes.csv            | [link](https://drive.google.com/file/d/19Ed_tRQhcz2zkdxL1GT-yD_eb6NXPUdn/view?usp=drive_link)    | EnergyPlusExample/ThermalModel_datacenter/Modes.csv            |
| PythonPOD_Solid.cgns | [link](https://drive.google.com/file/d/19H1HXCjzYx6ymz6PY_3xEAhDZdyza7D0/view?usp=sharing) | EnergyPlusExample/ThermalModel_datacenter/PythonPOD_Solid.cgns |

  

  

5. Build the container:

  

`docker compose build`

  
  
  

6. Give docker permission to display it's GUI app on host. This step must be repeated each time the computer/virtual machine is restarted: `xhost +local:docker`

  

7. Run the container:

  

`docker compose up`

  

  

8. You should see the app pop up:

  

![image](https://github.com/NREL/CoolerChips/assets/45446967/9189f34e-5b97-486d-8387-c5049401e23b)


  

  

## Sample results:

  

  

Simulation outputs:

  

![image](https://github.com/NREL/CoolerChips/assets/45446967/9dc5e93b-0303-4de4-87fd-588b7e70efc9)

  

  

Results from Paraview:

  

![image](https://github.com/NREL/CoolerChips/assets/45446967/f607abac-d3b3-4069-8778-86b1e5648a14)


## Individual Model Documentation:

1. Thermal model documentation can be found in the repo root as [NEITcool DOCUMENTATION.pdf](https://github.com/NREL/CoolerChips/blob/gui/NEITcool%20DOCUMENTATION.pdf).
2. EnergyPlus documentation can be found [here](https://energyplus.net/documentation). 
3. EnergyPlus Python API Documentation can be found [here](https://energyplus.readthedocs.io/en/latest/api.html). 
