-
Notifications
You must be signed in to change notification settings - Fork 389
Packaging Index
This wiki page is related to building packages (installers), but this somewhat defines our repo structure and design.
"Ideally", everything in the installer can be built directly from source, with minimal compilers/dependencies. The installer could be generated for any platform with essentially a single command. In EnergyPlus, the installers have relied on many things not built directly by the packaging system. EnergyPlus itself, along with the libraries (SQL, External Interface, DeLight) were built directly. Some utilities, such as transition, were also built directly. However, many other things were just dropped into the installer (pdfs, binary (GUI) tools). This is not great, but it worked.
At this point, we should discuss if there are things that can be dropped from the installer. The following table lists all the things that typically have gone into the package.
We won't be able to translate everything over to C++ before the next release. So we will still maintain a dependency on a Fortran compiler to do packaging. This isn't a huge deal because the CMake packaging commands were already established to build most of these. The issue is really all the other tools that we can't build (including Documentation).
| Language | Dependencies? | Can CMake build from source? | Notes | |
|---|---|---|---|---|
| PRIMARY TARGET | ||||
| EnergyPlus | C++ | Objexx/C++11 | Yes | |
| CORE E+ Libraries | ||||
| BCVTB | C/C++ | Yes | ||
| Zlib | C/C++ | Yes | ||
| FMIParser | C/C++ | Yes | ||
| FMUParser | C/C++ | Yes | ||
| Expat | C/C++ | Yes | ||
| DeLight | C/C++ | Yes | ||
| SQLite | C/C++ | Yes | ||
| "NEARLY CORE" E+ Stuff | ||||
| ep-macro | FORTRAN | Yes | ||
| expandobj | FORTRAN | Yes | ||
| ReadVarsESO | FORTRAN | Yes | ||
| OTHER FORTRAN PIECES | ||||
| ConvertESOMtr | FORTRAN | Yes | ||
| transition | FORTRAN | Yes | ||
| Parametric | FORTRAN | Yes | ||
| Basement | FORTRAN | Yes | ||
| Slab | FORTRAN | Yes | Should be deprecated soon | |
| HVACDiagram | FORTRAN | Yes | ||
| appG postprocess | FORTRAN | Yes | ||
| calcSoilSurfTemp | FORTRAN | Yes | ||
| coeffCheck | FORTRAN | Yes | Probably OK to not package | |
| blast/doe2 translators | FORTRAN | Yes | Probably OK to not package | |
| ViewFactorCalc | FORTRAN | Yes | ||
| WeatherConverter | FORTRAN | Yes | Licensing issues? | |
| PGrid3D | FORTRAN | Yes | Probably OK to not package | |
| OTHER RESOURCES | ||||
| Batch files, shell scripts, etc. | Plain Text | No: DropIn | ||
| HVACCurveFitTool.xlsm | Binary/Excel | No: DropIn | ||
| Documentation | Binary/PDF | No: Docx to PDF | ||
| Other text (readme, etc.) | Plain Text | No: DropIn | ||
| GUI/BINARY PIECES | ||||
| ep-launch | VB6 | VB6 Runtime Libraries | No: No VB6 Compiler | |
| idf-editor1 | VB6 | VB6 Runtime Libraries | No: No VB6 Compiler | Shouldn't be needed anymore |
| CSVProc.exe | VB6 | VB6 Runtime Libraries | No: No VB6 Compiler | Probably OK to not package? |
| idf-editor-2 | C++ | Qt, OpenStudio? | Yes | |
| idfversionupdater | RealBasic | RB Runtime Libraries | No: No RB Compiler | Probably want to translate this one |
| ep-draw | RealBasic | RB Runtime Libraries | No: No RB Compiler | Maybe OK to not package? |
| ep-compare | RealBasic | RB Runtime Libraries | No: No RB Compiler | Maybe OK to not package? |
| ep-launchlite | AppleScript | X/Code | ? No ? |