architecture-building-systems / CityEnergyAnalyst

The City Energy Analyst (CEA)
https://www.cityenergyanalyst.com/
MIT License
192 stars 61 forks source link

Tree organizational script structure for CEA #214

Closed jimenofonseca closed 8 years ago

jimenofonseca commented 8 years ago

capture

jimenofonseca commented 8 years ago

One thing we discussed sometime ago is the idea of making a folder structure for the current and future scripts of the CEA tool. We should definitely do this for the next release (even if we do not have the supply and optimization side ready) as it will help to show users to keep track of future releases.

I included an example of how other toolboxes are organized in ArcGis.

jimenofonseca commented 8 years ago

This is how i can see the tree taking place for the cea tool: @architecture-building-systems/cea Please feel free to comment and change until next friday 27.05.2016.

jimenofonseca commented 8 years ago

1 - CEA 1.1. DEMAND MODEL 1.1.1. SIMPLE DYNAMIC 1.1.2. VENTILATION 1.1.3. OCCUPANCY

1.2. RESOURCE POTENTIAL 1.2.1. SOLAR 1.2.2. AMBIENT-HEAT 1.2.3. WIND 1.2.4. WASTE 1.2.5. BIOMASS

1.3. TECHNOLOGIES 1.3.1. PV 1.3.2. SOLAR-THERMAL 1.3.3. PVT 1.3.4. CHP 1.3.5. HEAT-PUMP 1.3.6. WIND-TURBINE 1.3.7. CHILLER 1.3.8. COOLING-TOWER 1.3.9. ENERGY-STORAGE 1.3.9.1. BATTERY 1.3.9.2. SENSIBLE-HEAT-STORAGE 1.3.9.3. LATENT-HEAT-STORAGE

1.4. OPTIMIZATION 1.4.1. CONVERSION-SYSTEM 1.4.1.1. NGSA-II + MILP 1.4.1.2. OPS + MILP 1.4.1. NETWORK 1.4.1.1. NGSA-II + MILP 1.4.1.2. OPS + MILP

1.5. ANALYSIS 1.5.1. SENSITIVITY-ANALYSIS 1.5.2. LIFE-CYCLE-ANALYSIS 1.5.3. BENCHMARKING

1.6. PLOTS 1.6.1. HEAT-MAPS 1.6.2. TIME-SERIES 1.6.3. TOTALS

1.7. WORKFLOW (predefined either keppler or model builder workflow connecting all scripts) 1.7.1. LOW RESOLUTION SIMULATION 1.7.2. HIGH RESOLUTION SIMULATION

shanshanhsieh commented 8 years ago

I edited part 1.2 and added part 1.3 TECHNOLOGIES. It has became quite a long list now, maybe we could keep it part 1.3 like this now until we have other new technology models.

jimenofonseca commented 8 years ago

@daren-thomas @martin-mosteiro @gabriel-happle @amraladdin @shizhongming please comment in the folder structure of the CEA folder. today i expect to start implementing

gabriel-happle commented 8 years ago

I think the demand model should also have sub folders. E.g.

daren-thomas commented 8 years ago

Please make sure folder names have no spaces in them. Especially source code folders. While often spaces and non-ascii characters will work, it does tend to make everything more tedious. We could save ourselves some headaches.

jimenofonseca commented 8 years ago

@daren-thomas this will change the folder structure of the repository as discussed, i wonder if this is part of the "Architecture" you are investigating. The next step will be to accommodate the scripts we have in such structure. it could become messy so better we agree on one