Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make tables responsive #20

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion assets/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,22 @@ a.nav-button {
display: block;
}

.table-wrapper {
overflow-x: auto;
}

code {
overflow-x: auto;
}

p code {
word-break: break-word;
}

// Small devices
@media screen and (max-width: 480px) {

.inner {
max-width: 480px;
}
}
}
4 changes: 4 additions & 0 deletions docs/iidm/model/busbarSection.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,15 @@ element used in a node/breaker substation topology to connect equipments. In IID

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| V | double | kV | no | - | The voltage magnitude of the busbar section |
| Angle | double | ° | no | - | The voltage angle of the busbar section |

</div>

# Examples
This example shows how to create a new Busbar Section in a network:
```java
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/danglingLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ that aggregates a line chunk and a constant power injection. The active and reac

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| P0 | double | MW | yes | - | The active power setpoint |
Expand All @@ -18,6 +20,8 @@ that aggregates a line chunk and a constant power injection. The active and reac
| B | double | S | yes | - | The shunt susceptance |
| UcteXnodeCode | String | - | no | - | The dangling line's UCTE Xnode code |

</div>

## Electrical characteristics
R, X, G and B correspond to a percent of the original line and have to be consistent with the declared length of the
dangling line.
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The `com.powsybl.iidm.network.Generator` interface is used to model a generator.

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| EnergySource | `EnergySource` | - | yes | `OTHER` | The energy source |
Expand All @@ -19,6 +21,8 @@ The `com.powsybl.iidm.network.Generator` interface is used to model a generator.
| TargetV | double | kV | no | - | The voltage target |
| RatedS | double | MVA | yes | - | The rated nominal power |

</div>

## EnergySource
The `com.powsybl.iidm.network.EnergySource` enum contains these six values:
- HYDRO
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/hvdcConverterStation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,15 @@ class for [VSC]() and [LCC](). As such, its sub interfaces are:

## Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| HvdcType | `HvdcType` | - | yes | - | The HVDC type |
| LossFactor | float | % | yes | - | The loss factor |

</div>

## HVDC Type
The `com.powsybl.iidm.network.HvdcConverterStation.HvdcType` enum contains these two values:
- LCC
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/hvdcLine.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ converters](hvdcConverterStation.md) on DC side.

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| R | double | $$\Omega\$$ | yes | - | The resistance of the line |
Expand All @@ -18,6 +20,8 @@ converters](hvdcConverterStation.md) on DC side.
| ConverterStationId1 | String | - | yes | - | The ID of the HVDC converter station connected on side 1 |
| ConverterStationId2 | String | - | yes | - | The ID of the HVDC converter station connected on side 2 |

</div>

## ConvertersMode
The `com.powsybl.iidm.network.HvdcLine.ConvertersMode` enum contains these two values:
- SIDE_1_RECTIFIER_SIDE_2_INVERTER,
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/lccConverterStation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ a sub interface of [HvdcConverterStation](hvdcConverterStation.md).

## Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| PowerFactor | float | % | yes | - | The power factor |

</div>

## Examples
This example shows how to create a new `LccConverterStation` in a network:
```java
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/line.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The `com.powsybl.iidm.network.Line` interface is used to model an AC line. A lin

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| id | string | - | yes | - | Unique identifier of the line|
Expand All @@ -18,6 +20,8 @@ The `com.powsybl.iidm.network.Line` interface is used to model an AC line. A lin
| $$g_2$$ | double | S | yes | - | The second side shunt conductance |
| $$b_2$$ | double | S | yes | - | The second side shunt susceptance |

</div>

# Model
Power lines are modelled using a standard $$\pi$$ model with distributed parameters.

Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/load.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@ setpoints are fixed.

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- |-------- | ------------- | ----------- |
| LoadType | `LoadType` | - | no | `UNDEFINED` | The type of the load |
| P0 | double | MW | yes | - | The active power setpoint |
| Q0 | double | MVar | yes | - | The reactive power setpoint |

</div>

## LoadType
The `com.powsybl.iidm.network.LoadType` enum contains these three values:
- UNDEFINED
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@ The `Network` class contains [substations](substation.md), [AC lines](line.md),

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| id | String | yes | - | The ID of the network |
| name | String | no | - | The name of the network |
| caseDate | `DateTime` | no | Now | The date of the the case |
| ForecastDistance | Integer | no | 0 | The number of minutes between the date of the case generation and the case date |

</div>

# Example
This example shows how to create a new `Network` object:
```java
Expand Down
8 changes: 8 additions & 0 deletions docs/iidm/model/phaseTapChanger.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ It can be added to both [two windings transformers](./twoWindingsTransformer.md)

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| Low tap position | int | - | no | 0 | Position index of the tap changer's low tap |
Expand All @@ -17,8 +19,12 @@ It can be added to both [two windings transformers](./twoWindingsTransformer.md)
| Regulation value | double | MW or A | yes | - | The target value, depending on the regulation mode |
| Regulation terminal | Terminal | - | no | - | The terminal where regulation is done |

</div>

Each step of a phase tap changer has the following attributes:

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| $$r_{\phi, tap}$$ | double | % | yes | - | Resistance deviation in percent of nominal value |
Expand All @@ -28,6 +34,8 @@ Each step of a phase tap changer has the following attributes:
| $$\rho_{\phi, tap}$$ | double | p.u. | yes | - | Voltage ratio in per unit of the rated voltages |
| $$\alpha_{\phi, tap}$$ | double | $$^{\circ}$$ | yes | - | Angle difference |

</div>

# Model
A phase tap changer is regulating if **Regulating** is set to ```true```.

Expand Down
8 changes: 8 additions & 0 deletions docs/iidm/model/ratioTapChanger.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ It can be added to both [two windings transformers](./twoWindingsTransformer.md)

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| Low tap position | int | - | no | 0 | Position index of the tap changer's low tap |
Expand All @@ -17,8 +19,12 @@ It can be added to both [two windings transformers](./twoWindingsTransformer.md)
| Target V | double | kV | yes | - | The target voltage |
| Regulation terminal | Terminal | - | no | - | The terminal which voltage is regulated |

</div>

Each step of a ratio tap changer has the following attributes:

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- | -------- | ------------- | ----------- |
| $$r_{r, tap}$$ | double | % | yes | - | Resistance deviation in percent of nominal value |
Expand All @@ -27,6 +33,8 @@ Each step of a ratio tap changer has the following attributes:
| $$b_{r, tap}$$ | double | % | yes | - | Susceptance deviation in percent of nominal value |
| $$\rho_{r, tap}$$ | double | p.u. | yes | - | Voltage ratio in per unit of the rated voltages |

</div>

# Model
A ratio tap changer is regulating if both **Load tap changing capabilities** and **Regulating** are set to ```true```.
Remote control can be modelled by putting a distant terminal as regulation terminal.
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/shuntCompensator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ The `com.powsybl.iidm.network.ShuntCompensator` interface is used to model a shu

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- |-------- | ------------- | ----------- |
| bPerSection | double | S | yes | - | Positive sequence shunt (charging) susceptance per section |
| MaximumSectionCount| integer | int | yes | - | The maximum number of sections that may be switched on |
| CurrentSectionCount | integer | int | yes | - | The current number of section that may be switched on |

</div>

## Section
A section of a shunt compensator is an individual capacitor or reactor.

Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/staticVarCompensator.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The `com.powsybl.iidm.network.StaticVarCompensator` interface is used to model a

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Unit | Required | Default value | Description |
| --------- | ---- | ---- |-------- | ------------- | ----------- |
| Bmin | double | S | yes | - | The minimum susceptance |
Expand All @@ -15,6 +17,8 @@ The `com.powsybl.iidm.network.StaticVarCompensator` interface is used to model a
| ReactivePowerSetpoint | double | MVar | no | - | The reactive power setpoint |
| RegulationMode | `RegulationMode` | - | yes | - | The regulation mode |

</div>

## RegulationMode
The `com.powsybl.iidm.network.StaticVarCompensator.RegulationMode` enum contains these three values:
- VOLTAGE
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/substation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ A substation is located in a single country and belongs to one TSO.

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| id | String | yes | - | The ID of the substation |
Expand All @@ -19,6 +21,8 @@ A substation is located in a single country and belongs to one TSO.
| tso | String | no | - | The TSO this substations belongs to |
| geographicalTags | List of String | no | - | A list of geographical tags |

</div>

# Example
This example shows how to create a new `Substation` object:
```java
Expand Down
4 changes: 4 additions & 0 deletions docs/iidm/model/switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ The `com.powsybl.iidm.network.Switch` interface is used to a switch which connec

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| Kind | `SwitchKind` | yes | - | The kind of switch |
Expand All @@ -18,6 +20,8 @@ The `com.powsybl.iidm.network.Switch` interface is used to a switch which connec
| Bus1 | String | no | - | The first bus the switch is connected to |
| Bus2 | String | no | - | The second bus the switch is connected to |

</div>

Node1 and Node2 are required in a node/breaker topology.
Bus1 and Bus2 are required in a bus/breaker topology.

Expand Down
16 changes: 16 additions & 0 deletions docs/iidm/model/terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ topology. A terminal is created when the equipment it is connected to is created

# Characteristics

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| VoltageLevel | `VoltageLevel` | yes | - | The voltage level to which the terminal belongs |
Expand All @@ -20,6 +22,8 @@ topology. A terminal is created when the equipment it is connected to is created
| I | double | no | - | The current at the terminal |
| Connected | boolean | yes | - | The connection status of the terminal (true if the terminal is connected, else false) |

</div>

## View
The available views for the terminal depends of the topology level (node/breaker or bus/breaker) of the voltage level it
belongs to. More information about topology levels can be found on the [voltage level](voltageLevel.md) page.
Expand All @@ -30,32 +34,44 @@ breakers and disconnectors.

**Characteristics**

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| Node | int | yes | - | The connection node of the viewed terminal in a node/breaker topology |

</div>

### BusBreakerView
`BusBreakerView` is a view available in a node/breaker or a bus/breaker topology. It presents an aggregated view of the
topology made of buses and switches.

**Characteristics**

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| Bus | `Bus` | yes | - | The connection bus of the viewed terminal in a bus/breaker topology |
| ConnectableBus | `Bus` | yes | - | A bus that can be used to connect the viewed terminal in a bus/breaker topology |

</div>

### BusView
`BusView` is a view available in a node/breaker, a bus/breaker or a bus only topology. It presents an aggregated view of
the topology made of buses.

**Characteristics**

<div class="table-wrapper" markdown="block">

| Attribute | Type | Required | Default value | Description |
| --------- | ---- | -------- | ------------- | ----------- |
| Bus | `Bus` | yes | - | The connection bus of the viewed terminal in a bus only topology |
| ConnectableBus | `Bus` | yes | - | A bus that can be used to connect the viewed terminal in a bus only topology |

</div>

# Examples
This example shows how to use the terminal of an [injection](injection.md):
```java
Expand Down
Loading