Skip to content

Commit a2f7536

Browse files
AadilLatifAadilLatif
authored
Merge pull request #64 from NLR-Distribution-Suite/dependabot/github_actions/davidslusser/actions_python_ruff-1.0.3
chore: migrate docs build to Jupyter Book v2 and commit all workspace…
2 parents 0ef6d0f + 0d3825f commit a2f7536

10 files changed

Lines changed: 76 additions & 89 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ jobs:
3838
run: rm -rf docs/_build
3939

4040
- name: Build Jupyter Book
41-
run: jupyter-book build docs
41+
working-directory: docs
42+
run: jupyter-book build --html --force
4243

4344
- name: Deploy to GitHub Pages
4445
run: ghp-import -n -p -f docs/_build/html

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ __pycache__/
1010

1111
# C extensions
1212
*.so
13-
13+
*.db
1414
notebooks/*.csv
1515
erad_web/
1616
*.pdf

‎_build/logs/myst.build.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"input": {
3+
"files": [
4+
"docs"
5+
],
6+
"opts": {
7+
"execute": false,
8+
"executeParallel": 13,
9+
"pdf": false,
10+
"tex": false,
11+
"typst": false,
12+
"docx": false,
13+
"md": false,
14+
"xml": false,
15+
"meca": false,
16+
"cff": false,
17+
"site": false,
18+
"html": true,
19+
"all": false,
20+
"doiBib": false,
21+
"watch": false,
22+
"force": true,
23+
"checkLinks": false,
24+
"strict": false,
25+
"ci": false,
26+
"maxSizeWebp": 1572864,
27+
"keepHost": false
28+
}
29+
},
30+
"exports": []
31+
}

‎docs/api/data_models.md‎

Lines changed: 24 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,36 @@
11
# Data Models
22

3-
## Hazard Models
4-
5-
### Earthquake Models
6-
```{eval-rst}
7-
.. autopydantic_model:: erad.models.hazard.earthquake.EarthQuakeModel
8-
:exclude-members: example, validate_fields
9-
```
10-
11-
### Wind Models
12-
13-
```{eval-rst}
14-
.. autopydantic_model:: erad.models.hazard.wind.WindModel
15-
```
16-
17-
### Flood Models
18-
19-
```{eval-rst}
20-
.. autopydantic_model:: erad.models.hazard.flood.FloodModelArea
21-
```
22-
23-
```{eval-rst}
24-
.. autopydantic_model:: erad.models.hazard.flood.FloodModel
25-
```
26-
27-
### Fire Models
28-
29-
```{eval-rst}
30-
.. autopydantic_model:: erad.models.hazard.wild_fire.FireModel
31-
```
32-
33-
```{eval-rst}
34-
.. autopydantic_model:: erad.models.hazard.wild_fire.FireModelArea
35-
```
3+
This page lists the primary ERAD model classes.
364

37-
## Asset Model
38-
39-
```{eval-rst}
40-
.. autopydantic_model:: erad.models.asset.AssetState
41-
42-
.. autopydantic_model:: erad.models.asset.Asset
43-
```
44-
45-
## Asset Mapping Model
46-
47-
```{eval-rst}
48-
49-
.. autopydantic_model:: erad.models.asset_mapping.ComponentFilterModel
50-
51-
.. autopydantic_model:: erad.models.asset_mapping.AssetComponentMap
52-
```
53-
54-
55-
## Fragility Model
5+
## Hazard Models
566

57-
```{eval-rst}
58-
.. autopydantic_model:: erad.models.fragility_curve.ProbabilityFunction
7+
- `erad.models.hazard.earthquake.EarthQuakeModel`
8+
- `erad.models.hazard.wind.WindModel`
9+
- `erad.models.hazard.flood.FloodModelArea`
10+
- `erad.models.hazard.flood.FloodModel`
11+
- `erad.models.hazard.wild_fire.FireModel`
12+
- `erad.models.hazard.wild_fire.FireModelArea`
5913

60-
.. autopydantic_model:: erad.models.fragility_curve.FragilityCurve
14+
## Asset Models
6115

62-
.. autopydantic_model:: erad.models.fragility_curve.HazardFragilityCurves
16+
- `erad.models.asset.AssetState`
17+
- `erad.models.asset.Asset`
6318

64-
```
19+
## Asset Mapping Models
6520

66-
## Probabaility Model
21+
- `erad.models.asset_mapping.ComponentFilterModel`
22+
- `erad.models.asset_mapping.AssetComponentMap`
6723

68-
```{eval-rst}
69-
.. autopydantic_model:: erad.models.probability.BaseProbabilityModel
70-
```
71-
### Speed Model
72-
```{eval-rst}
73-
.. autopydantic_model:: erad.models.probability.SpeedProbability
74-
```
24+
## Fragility Models
7525

76-
### Temperature Model
77-
```{eval-rst}
78-
.. autopydantic_model:: erad.models.probability.TemperatureProbability
79-
```
26+
- `erad.models.fragility_curve.ProbabilityFunction`
27+
- `erad.models.fragility_curve.FragilityCurve`
28+
- `erad.models.fragility_curve.HazardFragilityCurves`
8029

81-
### Distance Model
82-
```{eval-rst}
83-
.. autopydantic_model:: erad.models.probability.DistanceProbability
84-
```
30+
## Probability Models
8531

86-
### Acceleration Model
87-
```{eval-rst}
88-
.. autopydantic_model:: erad.models.probability.AccelerationProbability
89-
```
32+
- `erad.models.probability.BaseProbabilityModel`
33+
- `erad.models.probability.SpeedProbability`
34+
- `erad.models.probability.TemperatureProbability`
35+
- `erad.models.probability.DistanceProbability`
36+
- `erad.models.probability.AccelerationProbability`

‎docs/api/enumerations.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Enumerations
22

3+
The main enumeration types are defined in `erad.enums`:
34

4-
```{eval-rst}
5-
.. automodule:: erad.enums
6-
:members: ScenarioTypes, NodeTypes, AssetTypes
7-
8-
```
5+
- `ScenarioTypes`
6+
- `NodeTypes`
7+
- `AssetTypes`

‎docs/api/quantities.md‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# Quantities
22

3+
Quantity definitions are provided by `erad.quantities`.
34

4-
```{eval-rst}
5-
.. automodule:: erad.quantities
6-
:members:
7-
8-
```
5+
Use these objects when building or interpreting hazard and fragility inputs in ERAD workflows.

‎docs/myst.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 1
2+
project:
3+
id: 18f87784-7fc8-44fa-946e-ecf2ce689587
4+
title: ERAD
5+
authors:
6+
- name: Aadil Latif
7+
bibliography:
8+
- references.bib
9+
site:
10+
template: book-theme
11+
options:
12+
logo: _static/light.png

‎example_1_results.db‎

-2.16 MB
Binary file not shown.

‎post_simulation_run_example_2.db‎

-48 KB
Binary file not shown.

‎pre_simulation_run_example_2.db‎

-8 KB
Binary file not shown.

0 commit comments

Comments
 (0)