Skip to content

Commit cc2b9af

Browse files
fix(docs): update installation instructions and add build script recommendation
1 parent 2ebf96d commit cc2b9af

2 files changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- **Comprehensive cable modeling:** Detailed representation of conductors (solid, tubular, stranded), insulation layers, screens, armoring, and semicons.
1515
- **Line and cable constants:** Accurate DC and AC parameters (R, L, C, G) with correction factors for temperature, stranding, and helical effects.
1616
- **Propagation characteristics:** Rigorous electromagnetic models for cable internal impedances and earth-return paths.
17-
- **Multiple solvers:** Analytical formulations, finite element modeling, and interfaces to EMT programs, including PSCAD.
17+
- **Multiple solvers:** Analytical formulations, finite element modeling, and interfaces to EMT programs, including ATPDraw and PSCAD.
1818
- **Materials and cables library:** Store and reuse standardized material properties and cable designs across projects.
1919

2020
## Documentation
@@ -25,10 +25,18 @@ See the [full documentation](https://electa-git.github.io/LineCableModels.jl/) f
2525

2626
Clone the package and add to the Julia environment:
2727

28-
```julia
29-
] add https://github.com/Electa-Git/LineCableModels.jl.git
28+
```julia-repl
29+
pkg> add https://github.com/Electa-Git/LineCableModels.jl.git
3030
```
3131

32+
If you are using the finite-element solver, it is recommended to run the build script to retrieve the required `GetDP` binaries:
33+
34+
```julia-repl
35+
pkg> build LineCableModels
36+
```
37+
38+
Then, in your Julia code, import the package:
39+
3240
```julia
3341
using LineCableModels
3442
```

docs/src/index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,18 @@ Depth = 1
2828

2929
Clone the package and add to the Julia environment:
3030

31-
```julia
32-
] add https://github.com/Electa-Git/LineCableModels.jl
31+
```julia-repl
32+
pkg> add https://github.com/Electa-Git/LineCableModels.jl.git
3333
```
3434

35+
If you are using the finite-element solver, it is recommended to run the build script to retrieve the required `GetDP` binaries:
36+
37+
```julia-repl
38+
pkg> build LineCableModels
39+
```
40+
41+
Then, in your Julia code, import the package:
42+
3543
```julia
3644
using LineCableModels
3745
```

0 commit comments

Comments
 (0)