DOC: update readme with minor revisions.

lanl-ansi · Apr 26, 2024 · 3a22310 · 3a22310
1 parent a719b27
commit 3a22310
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - This refactor significantly reduces loops and should reduce time to build ITD JuMP models.
 - This refactor also allows building ITD models where multiple distro. systems can be connected to same trans. system bus and KCL constraints are not duplicated.
 - Bumped PMITD compatibility of `PMD` to the latest version (i.e., v0.15.2).
+- Updated `README.md` with minor revisions.
 
 ## v0.8.1
 

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 [![CI](https://github.com/lanl-ansi/PowerModelsITD.jl/workflows/CI/badge.svg)](https://github.com/lanl-ansi/PowerModelsITD.jl/actions?query=workflow%3ACI) [![Documentation](https://github.com/lanl-ansi/PowerModelsITD.jl/workflows/Documentation/badge.svg)](https://lanl-ansi.github.io/PowerModelsITD.jl/stable/)
 
-`PowerModelsITD.jl` is an extention package of PowerModels.jl and PowerModelsDistribution.jl for Steady-State Integrated Transmission-Distribution (ITD) Power Network Optimization. It is designed to enable computational evaluation of emerging power network formulations and algorithms in a common platform. The code is engineered to decouple problem specifications (e.g. Power Flow, Optimal Power Flow, ...) from power network formulations (e.g. AC polar, AC rectangular, linear-approximation, SOC-relaxation, ...) on both transmission and distribution system(s). Thus, enabling the definition of a wide variety of ITD power network formulations and their comparison on common problem specifications.
+`PowerModelsITD.jl` is an extention package based on [PowerModels.jl](https://github.com/lanl-ansi/PowerModels.jl) and [PowerModelsDistribution.jl](https://github.com/lanl-ansi/PowerModelsDistribution.jl) for steady-state Integrated Transmission-Distribution (ITD) power network optimization. It is designed to enable the computational evaluation of emerging power network formulations and algorithms in a common platform. The code is engineered to decouple problem specifications (e.g. Power Flow, Optimal Power Flow, ...) from power network formulations (e.g. AC polar, AC rectangular, linear-approximation, SOC-relaxation, ...) on both transmission and distribution system(s). Thus, enabling the definition of a wide variety of ITD power network formulations and their comparison on common problem specifications.
 
 ## Core Problem Specifications
 
@@ -44,9 +44,9 @@
 
 Please see our [online documentation](https://lanl-ansi.github.io/PowerModelsITD.jl/stable/) for information about how to install and use `PowerModelsITD`. Local documentation can also be generated by following instructions in `./docs`.
 
-## Examples
+## Examples/Tutorials
 
-Examples of how to use `PowerModelsITD` can be found in the main documentation and in Pluto Notebooks inside the `/examples` directory.
+Examples of how to use `PowerModelsITD` can be found in the main documentation in the [Beginners Guide](https://lanl-ansi.github.io/PowerModelsITD.jl/stable/tutorials/BeginnersGuide.html).
 
 ## Development