### ThermalStation with Boiler Example

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

An example of a simple thermal station that includes essential child elements like Pump, TemperatureSetpoint, PressureSetpoint, and an energy conversion unit (Boiler).

```XML
<ThermalStation type="simple" beginDay="1" endDay="365" linkedNodeId="0">
<Pump ... />
<TemperatureSetpoint ... />
<PressureSetpoint ... />
<Boiler Pmax="200000" eta_th="0.95"/>
</ThermalStation>
```

--------------------------------

### Build FMILib on Linux/Mac

Source: https://github.com/kaemco/citysim-solver/blob/main/FMILibrary/doc/FMILIB_Readme.txt

Use this command to build the FMI Library on Linux or Mac with default settings. Ensure you set the installation prefix.

```bash
mkdir build-fmil; cd build-fmil
cmake -DFMILIB_INSTALL_PREFIX=<prefix> <path to FMIL source>
make install test
```

--------------------------------

### Build FMILib on Windows (Visual Studio)

Source: https://github.com/kaemco/citysim-solver/blob/main/FMILibrary/doc/FMILIB_Readme.txt

Build the FMI Library using Microsoft Visual Studio compilers on Windows. Specify the Visual Studio generator and the installation prefix.

```bash
mkdir build-fmil; cd build-fmil
cmake -DFMILIB_INSTALL_PREFIX=<prefix> -G "Visual Studio 10" <path to FMIL source>
cmake --build . --config MinSizeRel --target install
```

--------------------------------

### Detailed Tree example with vertices

Source: https://github.com/kaemco/citysim-solver/wiki/The-District

An example of a specific Tree tag, including detailed vertex data for its Leaf and Trunc components. This allows for precise geometric representation.

```XML
<Tree class="C3" deciduous="false" id="34" key="Tree34" leafAreaIndex="1" 
leafDistance="1" leafWidth="0.1" name="Platane à feuilles d' érable">
<Leaf LongWaveEmissivity="0.95" ShortWaveReflectance="0.3" id="35">
<V0 x="137.53599999845028" y="-561.4200000008568" z="628.5086689316406" />
 <V1 x="136.53599999845028" y="-559.6880000008568" z="628.5086689316406" /> 
<V2 x="134.53599999845028" y="-559.6880000008568" z="628.5086689316406" /> 
<V3 x="133.53599999845028" y="-561.4200000008568" z="628.5086689316406" /> 
<V4 x="134.53599999845028" y="-563.1520000008568" z="628.5086689316406" /> 
<V5 x="136.53599999845028" y="-563.1520000008568" z="628.5086689316406" />
</Leaf>
<Trunc LongWaveEmissivity="0.95" ShortWaveReflectance="0.3" id="36">
<V0 x="2578197.837999998" y="1183026.8199615234" z="621.5086689316406" /> 
<V1 x="2578197.837999998" y="1183026.8199615234" z="628.5086689316406" /> 
<V2 x="2578197.8679999984" y="1183026.7679999992" z="628.5086689316406" />
 <V3 x="2578197.8679999984" y="1183026.7679999992" z="621.5086689316406" />
</Trunc>
(more Trunc tags...)
</Tree>
```

--------------------------------

### Build FMILib on Windows (MSYS)

Source: https://github.com/kaemco/citysim-solver/blob/main/FMILibrary/doc/FMILIB_Readme.txt

Build the FMI Library in an MSYS terminal using g++/gcc on Windows. Specify the MSYS Makefiles generator and the installation prefix.

```bash
mkdir build-fmil; cd build-fmil
cmake -DFMILIB_INSTALL_PREFIX=<prefix> -G "MSYS Makefiles" <path to FMIL source>
make install test
```

--------------------------------

### CitySim Climate File Header Example

Source: https://github.com/kaemco/citysim-solver/wiki/The-Climate-File

The header of a .cli file specifies the city name and its geographical coordinates (latitude, longitude, altitude) and meridian.

```text
Basel 
47.55,7.583,316,1
```

--------------------------------

### NodePair ID Conflict Example

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Illustrates an incorrect configuration where ThermalStationNodePair and NodePair share the same ID, which is not allowed. Node IDs must be unique.

```XML
<ThermalStationNodePair id="5" z="1510"/>
<NodePair id="5" z="500.0"/>
```

--------------------------------

### Define Node Pairs in District Energy Center

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Example of defining various node pairs within a district energy center configuration. Ensure IDs are unique across the entire district.

```XML
<NodePair id="13" z="1500"/>
<SubstationNodePair id="14" z="1500"/>
<NodePair id="15" z="1500"/>
<ThermalStationNodePair id="17" z="1510"/>
```

--------------------------------

### CitySim XML Header Example

Source: https://github.com/kaemco/citysim-solver/wiki/The-Header

This XML snippet defines the header for a CitySim simulation. It specifies the simulation period and references a climate file. Ensure sprngSeed is a unique unsigned 32-bit integer for stochastic model results.

```xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<CitySim>
<Simulation beginMonth="1" endMonth="12" beginDay="1" endDay="31" sprngSeed =”1”/>
 <Climate location="./climateFiles/Basel.cli"/>
```

--------------------------------

### Define Pipe Pair with Supply and Return Pipes

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Example of a PipePair element connecting two nodes, specifying length, inner radius, and inter-pipe distance. It includes child elements for SupplyPipe and ReturnPipe, detailing insulation and burial depth.

```XML
<PipePair id="0" node1="0" node2="2" length="26.02797805189775" innerRadius="0.04445" interPipeDistance="0.5">
<SupplyPipe insulationThick="0.055549999999999995" insulationkValue="0.023" buriedDepth="1"/>
<ReturnPipe insulationThick="0.055549999999999995" insulationkValue="0.023" buriedDepth="1"/>
</PipePair>
```

--------------------------------

### HeatSource with Simple Boiler

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Configures a simple boiler as a heat source, specifying maximum power and thermal efficiency. This is a basic setup for a heating system.

```XML
<HeatSource beginDay="288" endDay="135">
<Boiler Pmax="500000" eta_th="0.96"/>
</HeatSource>
```

--------------------------------

### Get Build Timestamp Function

Source: https://github.com/kaemco/citysim-solver/blob/main/FMILibrary/doc/FMILIB_Readme.txt

Retrieves the build time stamp generated during the library build. This function is available when FMILIB_GENERATE_BUILD_STAMP is enabled.

```c
const char* fmilib_get_build_stamp(void);
```

--------------------------------

### Simulate Occupancy and Block Absence

Source: https://github.com/kaemco/citysim-solver/blob/main/scrap.txt

This C++ code simulates room occupancy and manages block absence periods, determining absence duration and checking for occupant return. It uses random number generation to decide on absence start and duration.

```cpp
                    if (blockAbs0==0){
                        x=randomUniform(0.0,1.0);
                        if (x < pLongAbsence){
                            blockAbs=1;
                            x = randomUniform(0.0,1.0);
                            count = 0;
                            for(int l = 0;l < vLongAbs.size();l++){
                                if(vLongAbs[l]<x)
                                    count+=1;
                            }
                            x=randomUniform(0.0,1.0);
                            dBlockAbs=(count+x)*absDurationBin+absDurationMin;
                            tEndBlockAbs = i + dBlockAbs*4;
                        }
                        else blockAbs = 0;

                    }
                    else{
                        if (i > tEndBlockAbs) blockAbs=0;
                        else blockAbs=1;
                        }

                    if (blockAbs==1)
                        occ=0;
                    else if ((blockAbs0==1)&&(blockAbs==0))
                        occ=1;
                    else{
                        x=randomUniform(0.0,1.0);
                        if (occ0==0){
                            if (T01[k]>x) occ=1;
                            else occ=0;
                        }
                        else if (occ0==1){
                            T10[k]=1-T11[k];
                            if (T10[k]>x) occ=0;
                            else occ=1;
                        }
                    }
                    occ0 = occ;
                    blockAbs0 = blockAbs;

                    nbPers[i+1] += occ;

                }
            }

        }

    pDistrict->getBuilding(b)->getZone(z)->setPresence(nbPers);

    }
    }

}
```

--------------------------------

### Configure Simple Substation

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Adds a substation to a CoolSource or HeatSource. Requires a linkedNodeId, design thermal power, temperature difference, and performance epsilon.

```XML
<CoolSource beginDay="136" endDay="257">
<Substation type="simple" designEpsilon="0.8" designTempDifference="10" designThermalPower="8000" linkedNodeId="39"/>
</CoolSource>
```

--------------------------------

### Model Window Opening Based on Temperature and Probability

Source: https://github.com/kaemco/citysim-solver/blob/main/scrap.txt

This C++ function calculates window opening status based on indoor and outdoor temperatures, atmospheric pressure, and various probabilistic models. It includes deterministic and logistic regression models for window opening.

```cpp
void Model::WindowsOpening(Building *pBuilding, Climate *pClimate, unsigned int step, unsigned int step2, double &Nvent){

    double To =  pClimate->getToutCelsius(dt*step), Ti;
    double patm = pClimate->getPatm(step);
    const double C = 0.6;
    const double g = 9.81;
    double rho;
    double Vdot;
    bool windowOpen = true;
    double winArea, h = 1, W = 1, V;

    double a, b,c, alea, pactwin;


        for (int i=0;i<pBuilding->getnZones();i++) {
        if (step2==0) Ti = pBuilding->getZone(i)->getTa(step);
        else Ti = pBuilding->getZone(i)->getTaExpl(step*12+step2-1);


            if (windowOpen){

```

--------------------------------

### Affine Temperature Setpoint Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Configures a temperature setpoint that varies affinely with external temperature. Specify temperature ranges and corresponding supply temperatures for interpolation.

```XML
<TemperatureSetpoint type="affine" lowExtTemp="-10" highExtTemp="15" lowExtTempSupplyTemp="90" highExtTempSupplyTemp="75" />
```

--------------------------------

### Define Composite Material for Asphalt Road

Source: https://github.com/kaemco/citysim-solver/wiki/The-District

Defines a composite material for an asphalt road with four distinct layers, specifying their properties. This example illustrates a ground composite.

```XML
<Composite id="8" name="Asphalt Road">
<Layer Thickness="0.025" Conductivity="0.75" Cp="920.0" Density="2360.0"/>
<Layer Thickness="0.02" Conductivity="0.5" Cp="828.0" Density="1300.0"/>
<Layer Thickness="0.1" Conductivity="0.7" Cp="936.0" Density="1800.0"/>
<Layer Thickness="0.85" Conductivity="3.4" Cp="936.0" Density="2200.0"/>
</Composite>
```

--------------------------------

### Presence Model Implementation in C++

Source: https://github.com/kaemco/citysim-solver/blob/main/scrap.txt

This C++ function implements the Presence Model, which calculates occupancy distribution within buildings based on presence profiles and long-term absence data. It requires building and climate data as input.

```cpp
void Model::Presence(District *pDistrict, int NTS){

    vector<double> pd; //presence distribution
    //load("presence.txt", pd); // commented here JK - 20.03.09 (due to removal of fct.cpp)

    vector<double> T11, T01, T10, vLongAbs,vLongAbs0;
    vector<int> nbPers;
    int nbPersMax;
    double mu, beta, pLongAbsence, x;   //beta is the mobility factor (mu) adjusted
    //load("LongAbs.txt", vLongAbs0); // commented here JK - 20.03.09 (due to removal of fct.cpp)
    for (unsigned int b=0;b<pDistrict->getnBuildings();b++){
    for (unsigned int z=0;z<pDistrict->getBuilding(b)->getnZones();z++){
        mu = pDistrict->getBuilding(b)->getZone(z)->getMu();                   //parametre de mobilit
        pLongAbsence = pDistrict->getBuilding(b)->getZone(z)->getDayOff()/52 / (7*24*4);

        nbPersMax = pDistrict->getBuilding(b)->getZone(z)->getNbPersMax();

        nbPers.assign(NTS, 0);
        T01.assign (pd.size(), 0.0);
        T11.assign (pd.size(), 0.0);
        T10.assign (pd.size(), 0.0);



        ///Determination de T01 et T11
        beta = mu; //ajustement du mu
        for (int i = 0;i < pd.size();i++){
            if(pd[i+1]==0){
                T01[i] = 0;
                T11[i] = 0;
            }
            else if(pd[i+1]==1){
                T01[i] = 1;
                T11[i] = 1;
            }
            else{
                if (pd[i]==1){
                    T11[i] = pd[i+1];
                    T01[i] = 0;
                }
                else if (pd[i]==0){
                    T01[i]=pd[i+1];
                    T11 [i]=0;
                }
                else if (pd[i] == pd[i+1]){
                    if (pd[i] + pd[i+1]>1){
                        if (mu>1/(2*pd[i]-1))
                            beta=1/(2*pd[i]-1);
                        else beta=mu;
                    }


                    else if (pd[i]+pd[i+1] < 1){
                        if (mu > 1/(1-2*pd[i]))
                            beta = 1/(1-2*pd[i]);
                        else beta = mu;
                    }
                    else beta = mu;
                    T01[i] = 2*beta*pd[i]/(beta+1);
                    T11[i] = 1-(1-pd[i])*T01[i]/pd[i];
                }


                else if (pd[i]<pd[i+1]){
                    if (mu<(pd[i+1]-pd[i])/(2-(pd/*chang in pd*/[i+1]+pd/*iciToo*/[i])))
                        beta = (pd[i+1]-pd[i])/(2-(pd/*iciToo*/[i+1]+pd[i]));
                    else if ((pd[i]+pd[i+1] > 1) && (mu>(pd[i]-pd[i+1]+1)/(pd[i+1]+pd[i+1]-1)))
                            beta=(pd[i]-pd[i+1]+1)/(pd[i+1]+pd[i+1]-1);
                    else if ((pd[i]+pd[i+1]<1) && (mu > (1-pd[i]+pd[i+1])/(1-pd[i]-pd[i+1])))
                            beta=(1-pd[i]+pd[i+1])/(1-pd[i]-pd[i+1]);
                    else beta = mu;

                T01[i] = pd[i+1]+pd[i]*(beta-1)/(beta+1);
                T11[i] = 1/pd[i]*(pd[i+1]-(1-pd[i])*T01[i]);
                }


                else{
                    if (mu<(pd[i]-pd[i+1])/(pd[i+1]+pd[i]))
                        beta =( pd[i]-pd[i+1])/(pd[i+1]+pd[i]);
                    else
                        if ((pd[i]+pd[i+1]>1) && (mu >(pd[i]-pd[i+1]+1)/(pd[i+1]+pd/*change p en pd*/[i]-1)))
                            beta = (pd[i]-pd[i+1]+1)/(pd[i+1]+pd[i]-1);
                        else if ((pd[i]+pd[i+1] < 1) && (mu > (1-pd[i]+pd[i+1])/(1-pd[i]-pd[i+1])))
                            beta=(1-pd[i]+pd[i+1])/(1-pd/*change pd en p*/[i]-pd[i+1]);
                        else beta=mu;

                    T01[i] = pd[i+1]+pd[i]*(beta-1)/(beta+1);
                    T11[i] = 1/pd[i]*(pd[i+1]-(1-pd[i])*T01[i]);
                }
            }
        }

    double dBlockAbs /*dur block absence*/ , absDurationBin = 12.0, absDurationMin =12.0, tEndBlockAbs /*fin du absence block */;

    vLongAbs = vLongAbs0;
    for (int i = 1; i < vLongAbs.size(); i++){
            vLongAbs[i] += vLongAbs[i-1];
            if (vLongAbs[i] > 1.0)
                vLongAbs[i] = 1.0;
    }

    int occ0, occ, blockAbs0, blockAbs, count;

    for (int j = 0;j<nbPersMax;j++){
        occ0=0; //% initial value of occupancy
        blockAbs0=0; //% initial value of block absence: 0 (normal occupancy)
        for (int i = 0;i< NTS-1 ; ){
            for (int k = 0; k < pd.size();k++,i++){
                    if (i >= NTS-1)

```

--------------------------------

### Constant Temperature Setpoint Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Defines a constant target supply temperature for a temperature setpoint. Use this when a fixed temperature is required regardless of external conditions.

```XML
<TemperatureSetpoint type="constant" targetSupplyTemp="80"/>
```

--------------------------------

### Add PV Panels to a Wall

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

This snippet demonstrates adding PV panels to a wall element. It specifies PV panel properties such as reference efficiency, nominal operating cell temperature, reference temperature, voltage at maximum power, and temperature coefficient.

```XML
<Wall GlazingGValue="0.47" GlazingRatio="0.1" GlazingUValue="2.3" OpenableRatio="0.5" ShortWaveReflectance="0.2" id="233702" type="107">
          <PV Etampref="0.21" Tcnoct="45" Tref="25" Vmp="57.3" muVoc="-0.1674" name="SunPower X21-335-BLK" pvRatio="1.0" />
          <V0 x="-497.84899999946356" y="-1047.109700000845" z="649.1275273789063" />
          <V1 x="-499.1655000001192" y="-1047.2646999983117" z="649.7595273789063" />
```

--------------------------------

### ThermalStation Configuration (Simple Type)

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Configures a simple thermal station within the DistrictEnergyCenter. It specifies the operational days, the linked node ID, and the type. This type can only produce heat or cold.

```XML
<ThermalStation beginDay="2" endDay="364" linkedNodeId="4" type="simple">
</ThermalStation>
```

--------------------------------

### Define Ground Surfaces with Detailed Simulation

Source: https://github.com/kaemco/citysim-solver/wiki/The-District

Defines triangular ground surfaces with properties like ShortWaveReflectance and kFactor. Setting detailedSimulation to true enables a more accurate, layer-by-layer ground temperature calculation.

```XML
<GroundSurface>
<Ground id="55" ShortWaveReflectance="0.2" type="8" kFactor="1" detailedSimulation="true">
<V0 x="15" y="30" z="0.0"/>
<V1 x="15 " y="25 " z="0.0"/>
<V2 x="40 " y="25 " z="0.0"/>
</Ground>
<Ground id="56" ShortWaveReflectance="0.3" type="8" kFactor="0" >
<V0 x="15 " y="30 " z="0.0"/>
<V1 x="40 " y="25 " z="0.0"/>
<V2 x="40" y="30 " z="0.0"/>
</Ground>
</GroundSurface>
```

--------------------------------

### Affine Pressure Setpoint Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Defines a pressure setpoint that varies affinely with mass flow. Multiple mass flow and pressure difference points are used to define piecewise affine behavior.

```XML
<PressureSetpoint type="affine" massFlow1="1.375" massFlow2="2.75" massFlow3="17.6"
 massFlow4="32.45" pressureDiff1="180000" pressureDiff2="250000"
 pressureDiff3="390000" pressureDiff4="480000"/>
```

--------------------------------

### Define Daily Occupancy Profile

Source: https://github.com/kaemco/citysim-solver/wiki/Occupant-profile

Defines the hourly occupancy rate for a single day. Use 'p' followed by the hour (1-24) to set the occupancy rate for that hour.

```XML
<OccupancyDayProfile id="1" p1="1.0" p2="1.0" p3="1.0" p4="1.0" p5="1.0" p6="1.0" p7="0.8" p8="0.6" p9="0.4" p10="0.4" p11="0.4" p12="0.6" p13="0.8"p14="0.6" p15="0.4" p16="0.4" p17="0.6" p18="0.8" p19="0.8" p20="0.8" p21="0.8" 
p22="1.0" p23="1.0" p24="1.0"/>
```

--------------------------------

### Define Building Wall with Basic Properties

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Use this XML structure to define a building wall with its type, thermal properties, glazing details, and vertex coordinates. The LongWaveEmissivity defaults to 0.9 if not specified.

```XML
<Wall id="57" type="7" ShortWaveReflectance="0.2" GlazingRatio="0.3" GlazingGValue="0.7" GlazingUValue="1.4" OpenableRatio="0.5" LongWaveEmissivity="0.5" >
<V0 x="156.28604298012556" y="2.6159466366386184" z="0.0"/>
<V1 x="56.33630857784846" y="2.6159466366386184" z="0.0"/>
<V2 x="56.33630857784846" y="2.6159466366386184" z="20.0"/> 
<V3 x="156.28604298012556" y="2.6159466366386184" z="20.0"/>
 </Wall>
```

--------------------------------

### Add PV Panels to a Roof

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

This snippet shows how to integrate PV panels onto a roof element. It includes the same PV panel technical properties as for walls, allowing for consistent simulation across different building surfaces.

```XML
<Roof GlazingGValue="0.7" GlazingRatio="0.3" GlazingUValue="1.4" OpenableRatio="0.0" ShortWaveReflectance="0.2" id="233686" type="119">
          <PV Etampref="0.21" Tcnoct="45" Tref="25" Vmp="57.3" muVoc="-0.1674" name="SunPower X21-335-BLK" pvRatio="1.0" />
          <V0 x="-481.8339999988675" y="-1042.0069999983534" z="652.9735273789063" />
          <V1 x="-491.53310000151396" y="-1043.1454000016674" z="653.2828273789062" />
```

--------------------------------

### Define Building Floor in XML

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Use this XML structure to define a building floor, including its ID, type, and vertex coordinates.

```XML
<Floor id="54" type="10">
<V0 x="56.33630857784846" y="-87.43429282902677" z="0.0"/>
 <V1 x="56.33630857784846" y="2.6159466366386184" z="0.0"/>
<V2 x="156.28604298012556" y="2.6159466366386184" z="0.0"/>
 <V3 x="156.28604298012556" y="-87.43429282902677" z="0.0"/>
</Floor>
```

--------------------------------

### Define Building Wall with PV and Solar Heater

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

This XML defines a wall with integrated photovoltaic panels and solar heaters, specifying their coverage ratios and performance parameters. It also allows direct U-value definition instead of referencing a wall type.

```XML
<Wall id="57" type="7" ShortWaveReflectance="0.2" GlazingRatio="0.3" 
GlazingGValue="0.7" GlazingUValue="1.4" OpenableRatio="0.5">
<PV pvRatio="0.5" Pmp="120" Ac="1.07" Tref="25" Tcnoct="47" 
muVoc="-0.08" Vmp="16.8"/>
<ST stRatio="0.1" eta0="0.778" a1="3.59" a2="0.0096"/>
<V0 x="156.28604298012556" y="2.6159466366386184" z="0.0"/>
 <V1 x="56.33630857784846" y="2.6159466366386184" z="0.0"/>
<V2 x="56.33630857784846" y="2.6159466366386184" z="20.0"/>
<V3 x="156.28604298012556" y="2.6159466366386184" z="20.0"/>
</Wall>
```

--------------------------------

### Daily DHW Profile Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/Occupant-profile

Defines a daily DHW profile with water consumption and hourly distribution probabilities. Use this to model typical daily hot water usage patterns.

```XML
<DHWDayProfile id="1" name=" IEA task 26 DHW profile" waterConsumption="50.0", 
 p1="0.0018", 
 p2="0.0019", p3="0.0019", p4="0.0018", p5="0.0018", p6="0.042", p7="0.090", p8="0.13", p9="0.090",
 p10="0.038", p11="0.038", p12="0.039", p13="0.040", p14="0.040", p15="0.040",
 p16="0.041", p17="0.040", p18="0.040", p19="0.053", p20="0.081", p21="0.073", p22="0.038",
 p23="0.036", p24="0.0018"/>
```

--------------------------------

### Network Configuration with Node and Pipe Definitions

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Configures the thermal network, including soil conductivity and detailed definitions of nodes and pipe segments. This structure is essential for simulating heat flow within the district energy system.

```XML
<Network soilkValue ="0.5”>
 <ThermalStationNodePair id="0" z="503"/>
 <SubstationNodePair id="1" z="509"/> 
<NodePair id="3" z="504"/>
<SubstationNodePair id="2" z="498"/>
<PipePair id="0" innerRadius="0.06" interPipeDistance="0.5" length="109" node1="0" node2="3"> 
<SupplyPipe buriedDepth="1" insulationThick="0.1" insulationkValue="0.04"/> 
<ReturnPipe buriedDepth="1" insulationThick="0.1" insulationkValue="0.04"/>
</PipePair>
<PipePair id="1" innerRadius="0.06" interPipeDistance="0.5" length="48" node1="3" node2="1">
<SupplyPipe buriedDepth="1" insulationThick="0.1" insulationkValue="0.04"/>
<ReturnPipe buriedDepth="1" insulationThick="0.1" insulationkValue="0.04"/>
</PipePair>
<PipePair id="2" innerRadius="0.05" interPipeDistance="0.5" length="63" node1="3" node2="2"> 
<SupplyPipe buriedDepth="1" insulationThick="0.1" insulationkValue="0.04"/>
 <ReturnPipe buriedDepth="1" insulationThick="0.1" insulationkValue="0.04"/>
</PipePair>
</Network>
```

--------------------------------

### Constant Pressure Setpoint Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Sets a constant target pressure difference for a pressure setpoint. Use this for applications requiring a fixed pressure differential.

```XML
<PressureSetpoint type="constant" targetPressureDiff="200000"/>
```

--------------------------------

### Building Tag Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Defines a building with identification, infiltration rate, blinds behavior, and simulation settings. Ensure 'id' is unique per building.

```XML
<Building id="1" key="buil34" Ninf="0.4" BlindsLambda ="0.2" BlindsIrradianceCutOff ="100" Simulate="true">

```

--------------------------------

### Substation Configuration for Prosumer HeatSource

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Configures a substation as a 'prosumer' for injecting solar thermal heat into the network. Requires flow control valve, temperature setpoint, pressure setpoint, and pump details. 'kvMaxFlowControlValve' is crucial for flow control.

```XML
<HeatSource beginDay="258" endDay="135">
<Substation type="prosumer" kvMaxFlowControlValve="1000" designEpsilon="0.6" 
designTempDifference="40"
designThermalPower="15000" linkedNodeId="2">
<TemperatureSetpoint type="constant" targetSupplyTemp="70"/>
<PressureSetpoint type="constant" targetPressureDiff="200000"/>
<Pump efficiencyPump="0.6" n0="1000" a0="1247180" a1="-1640.236" a2="-0.00016031"/> 
</Substation>
</HeatSource>
```

--------------------------------

### Define Activity Types and Activities

Source: https://github.com/kaemco/citysim-solver/wiki/Occupant-profile

XML structure for defining activity types, which group individual activities. Each activity has hourly mean probabilities and is associated with a device type. Probabilities are mutually exclusive and cumulative.

```XML
<ActivityType id="1" name="Sample Activity">
<Activity name="activity 1" p1="0.1" p2="0.1" p3="0.2" p4="0.2" 
p5="0.3" p6="0.3" p7="0.4" p8="0.5" p9="0.6" p10="0.6"
p11="0.8" p12="0.6" p13="0.1" p14="0.1" p15="0.2" p16="0.2" 
p17="0.3" p18="0.3" p19="0.4" p20="0.5" p21="0.6"
p22="0.6" p23="0.8" p24="0.6" deviceType="1"/>
<Activity name="activity 2" p1="0.5" p2="0.3" p3="0.3" p4="0.4"
 p5="0.4" p6="0.2" p7="0.2" p8="0.2" p9="0.3" p10="0.3"
p11="0.1" p12="0.3" p13="0.5" p14="0.3" p15="0.3" p16="0.4" 
p17="0.4" p18="0.2" p19="0.2" p20="0.2" p21="0.3"
p22="0.3" p23="0.1" p24="0.3" deviceType="1"/>
<Activity name="activity 3" p1="0.4" p2="0.6" p3="0.5" p4="0.4" 
p5="0.3" p6="0.5" p7="0.4" p8="0.3" p9="0.1" p10="0.1"
p11="0.1" p12="0.1" p13="0.4" p14="0.6" p15="0.5" p16="0.4" 
p17="0.3" p18="0.5" p19="0.4" p20="0.3" p21="0.1"
p22="0.1" p23="0.1" p24="0.1" deviceType="2"/> 
</ActivityType>
```

--------------------------------

### Define Device Types and Devices

Source: https://github.com/kaemco/citysim-solver/wiki/Occupant-profile

XML structure for defining device types and individual devices, including average power and heat gain fractions. Use this to model different types of electrical devices and their thermal properties.

```XML
<DeviceType id="1" name="sample device">
<Device name="device 1" avgPower="400" convectiveFraction="0.8" radiativeFraction="0.1" p1="0.1" p2="0.3" p3="0.05"
 p4="0.04" p5="0.03" p6="0.05" p7="0.8" p8="0.13" p9="0.6" p10="0.15" p11="0.18" p12="0.15" p13="0.54" p14="0.66"
 p15="0.35" p16="0.54" p17="0.73" p18="0.75" p19="0.44" p20="0.53" p21="0.61" p22="0.51" p23="0.12" p24="0.11"/>
 </DeviceType>

  <DeviceType id="2" name="Office">
      <Device name="Office device" avgPower="130" convectiveFraction="0.8" radiativeFraction="0.1" p1="0.001" 
 p2="0.001" p3="0.001" p4="0.001" p5="0.001" p6="0.001" p7="0.001" p8="0.2" p9="0.4" p10="0.6" p11="0.8" p12="0.8" 
p13="0.4" p14="0.6" p15="0.8" p16="0.8" p17="0.4" p18="0.2" p19="0.001" p20="0.001" p21="0.001" p22="0.001" p23="0.001" 
p24="0.001"/>
    </DeviceType>
```

--------------------------------

### HeatSource with Boiler Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Defines a heat source using a boiler, specifying its operational period and efficiency. The 'beginDay' and 'endDay' attributes define the active period.

```XML
<HeatSource beginDay="288" endDay="135">
<Boiler Pmax="500000" eta_th="0.96" name="boiler1"/>
</HeatSource>
```

--------------------------------

### Storage Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Defines a simple storage tank within a ThermalStation. It requires initial temperature and heat capacity. This is used for storing thermal energy.

```XML
<Storage type="simple" initialTemperature="30" heatCapacity="10000000000"/>
```

--------------------------------

### Configure Substation as Heat Pump (SubstationHP)

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Defines a substation that functions as a heat pump within a HeatSource. Includes substation parameters and additional heat pump characteristics like Pmax and target temperature.

```XML
<HeatSource beginDay="258" endDay="135">
<SubstationHP linkedNodeId="7" designThermalPower="360000" designTempDifference="5" designEpsilon="0.6" type="simple" Pmax="360000" eta_tech="0.3" Ttarget="70" Tsource="ground" position="vertical" depth="5" z1="10" alpha="0.07"/>
</HeatSource>
```

--------------------------------

### Define Building Roof with Basic Properties

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

This XML defines a building roof with its type, thermal properties, glazing details, and vertex coordinates. Similar to walls, roofs can also be fitted with PV panels.

```XML
<Roof id="55" type="9" ShortWaveReflectance="0.2" GlazingRatio="0.0" 
GlazingGValue="0.7" GlazingUValue="1.382436" OpenableRatio="0.5">
<V0 x="156.28604298012556" y="-87.43429282902677" z="20.0"/>
<V1 x="156.28604298012556" y="2.6159466366386184" z="20.0"/>
<V2 x="56.33630857784846" y="2.6159466366386184" z="20.0"/>
<V3 x="56.33630857784846" y="-87.43429282902677" z="20.0"/>
</Roof>
```

--------------------------------

### Define Micro Wind Turbine on Roof

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

This snippet defines a roof with an integrated micro wind turbine. It includes parameters for the turbine's operational speeds, performance coefficients, air density, hub height, and terrain interaction.

```XML
<Roof id="55" type="9" ShortWaveReflectance="0.2" GlazingRatio="0.0" 
GlazingGValue="0.7" GlazingUValue="1.382436" OpenableRatio="0.5">
<MicroWindTurbine cutInSpeed="3" ratedSpeed="14" cutOutSpeed="16" 
c1="28.98" c2="-66.63" c3="180.8" airDensity="1.2" Height="2" Gamma="0.25" 
Alpha="0.67"/>
<V0 x="156.28604298012556" y="-87.43429282902677" z="20.0"/>
 <V1 x="156.28604298012556" y="2.6159466366386184" z="20.0"/>
<V2 x="56.33630857784846" y="2.6159466366386184" z="20.0"/>
<V3 x="56.33630857784846" y="-87.43429282902677" z="20.0"/>
 </Roof>
```

--------------------------------

### Tank Configurations for Building

Source: https://github.com/kaemco/citysim-solver/wiki/The-building

Configures heat, domestic hot water (DHW), and cool tanks within a building. Specifies volume, density, specific heat, thermal losses, temperature ranges, and critical temperatures.

```XML
<HeatTank V="0.01" phi="20.0" rho="1000.0" Cp="4180.0" Tmin="30.0" Tmax="35.0" Tcritical="90.0"/> 
<DHWTank V="0.2" phi="20.0" rho="1000.0" Cp="4180.0" Tmin="50.0" Tmax="70.0" Tcritical="90.0" Tinlet="5.0"/>
<CoolTank V="0.01" phi="20.0" rho="1000.0" Cp="4180.0" Tmin="5.0" Tmax="20.0"/>
```

--------------------------------

### Pump Performance Parameters

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Specifies the performance characteristics of a pump, including its efficiency and parameters that describe its pressure-increasing capabilities based on flow rate.

```XML
<Pump efficiencyPump="0.6" n0="1000" a0="1247180" a1="-1640.236" a2="-0.00016031"/>
```

--------------------------------

### Yearly DHW Profile Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/Occupant-profile

Defines a yearly DHW profile by associating each day of the year with a specific daily DHW profile ID. This allows for seasonal variations in hot water usage.

```XML
<DHWYearProfile id="1" name="IEA task 26 Profile House" d1="1" d2="1" d3="1" 
 d4="1" d5="1" d6="1" d7="1" d8="1" d9="1" d10="1" d11="1" d12="1" d13="1" 
 d14="1" d15="1" d16="1" d17="1" d18="1" d19="1" d20="1" d21="1" d22="1" d23="1"
 d24="1" d25="1" d26="1" d27="1" d28="1" d29="1" d30="1" d31="1" d32="1" d33="1"
 d34="1" d35="1" d36="1" d37="1" d38="1" d39="1" d40="1" d41="1" d42="1" d43="1"
 d44="1" d45="1" d46="1" d47="1" d48="1" d49="1" d50="1" d51="1" d52="1" d53="1"
 d54="1" d55="1" d56="1" d57="1" d58="1" d59="1" d60="1" d61="1" d62="1" d63="1"
 d64="1" d65="1" d66="1" d67="1" d68="1" d69="1" d70="1" d71="1" d72="1" d73="1"
 d74="1" d75="1" d76="1" d77="1" d78="1" d79="1" d80="1" d81="1" d82="1" d83="1"
d250="1" d251="1" d252="1" d253="1" d254="1" d255="1" d256="1" d257="1" d258="1" 
 d259="1" d260="1" d261="1" d262="1" d263="1" d264="1" d265="1" d266="1" d267="1" 
 d268="1" d269="1" d270="1" d271="1" d272="1" d273="1" d274="1" d275="1" d276="1" 
 d277="1" d278="1" d279="1" d280="1" d281="1" d282="1" d283="1" d284="1" d285="1" 
 d286="1" d287="1" d288="1" d289="1" d290="1" d291="1" d292="1" d293="1" d294="1" 
 d295="1" d296="1" d297="1" d298="1" d299="1" d300="1" d301="1" d302="1" d303="1" 
 d304="1" d305="1" d306="1" d307="1" d308="1" d309="1" d310="1" d311="1" d312="1" 
 d313="1" d314="1" d315="1" d316="1" d317="1" d318="1" d319="1" d320="1" d321="1" 
 d322="1" d323="1" d324="1" d325="1" d326="1" d327="1" d328="1" d329="1" d330="1" 
 d331="1" d332="1" d333="1" d334="1" d335="1" d336="1" d337="1" d338="1" d339="1" 
 d340="1" d341="1" d342="1" d343="1" d344="1" d345="1" d346="1" d347="1" d348="1" 
 d349="1" d350="1" d351="1" d352="1" d353="1" d354="1" d355="1" d356="1" d357="1"
 d358="1" d359="1" d360="1" d361="1" d362="1" d363="1" d364="1" d365="1"/>
```

--------------------------------

### DistrictEnergyCenter Configuration

Source: https://github.com/kaemco/citysim-solver/wiki/District-Energy-Center

Defines a district energy center with its ID and heat transfer fluid properties. The dynamic viscosity can be set to a constant value or use the Vogel-Fulcher-Tammann formula for water.

```XML
<DistrictEnergyCenter id="8" Cp="4180" rho="990" mu="Vogel-Fulcher-Tammann">
</DistrictEnergyCenter>
```