Skip to content

Commit

Permalink
DOC: add PowerModelsITD logo and revised README.md (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
juanjospina authored Jun 22, 2022
1 parent c9da96a commit 792b438
Show file tree
Hide file tree
Showing 4 changed files with 1,441 additions and 16 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## staged

- none.
- Added `PowerModelsITD` logo.
- Revised `README.md`.

## v0.7.2

Expand Down
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# PowerModelsITD.jl

<img src="https://lanl-ansi.github.io/PowerModelsITD.jl/dev/assets/logo.svg" align="left" width="200" alt="PowerModelsITD logo">

[![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 Power Transmission-Distribution 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 the power network formulations (e.g. AC, linear-approximation, SOC-relaxation, ...) on both transmission and distribution system. Thus, enabling the definition of a wide variety of power network formulations and their comparison on common problem specifications.
`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.

## Core Problem Specifications

Expand All @@ -13,20 +15,22 @@ PowerModelsITD.jl is an extention package of PowerModels.jl and PowerModelsDistr

## Core Network Formulations

**Note**: _left_ is the formulation used to model the transmission system - _right_ is the unbalanced formulation used to model the distribution system(s).

- Nonlinear
- ACP-ACP
- ACR-ACR
- IVR-IVR
- ACP-ACPU
- ACR-ACRU
- IVR-IVRU
- Relaxations
- SOCBFM-SOCBFM (W-space)
- SOCBF-SOCUBF (W-space)
- Linear Approximations
- NFA-NFA
- DCP-DCP
- NFA-NFAU
- DCP-DCPU
- Hybrid
- ACR-FOTR (First-Order Taylor Rectangular)
- ACP-FOTP (First-Order Taylor Polar)
- ACR-FBS (Forward-Backward Sweep)
- SOCBFM-LinDist3Flow
- ACR-FOTRU (First-Order Taylor Rectangular)
- ACP-FOTPU (First-Order Taylor Polar)
- ACR-FBSU (Forward-Backward Sweep)
- SOCBF-LinDist3Flow
- BFA-LinDist3Flow

## Network Data Formats
Expand All @@ -37,17 +41,17 @@ PowerModelsITD.jl is an extention package of PowerModels.jl and PowerModelsDistr

## Documentation

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`.
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 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 and in Pluto Notebooks inside the `/examples` directory.

## Development

Community-driven development and enhancement of PowerModelsITD is welcomed and encouraged.
Community-driven development and enhancement of `PowerModelsITD` is welcomed and encouraged.
Please feel free to fork this repository and share your contributions to the main branch with a pull request.
When submitting a PR, please keep in mind the code quality requirements and scope of PowerModelsITD before preparing a contribution.
When submitting a PR, please keep in mind the code quality requirements and scope of `PowerModelsITD` before preparing a contribution.
See [CONTRIBUTING.md] for code contribution guidelines.

## Acknowledgments
Expand Down
Loading

0 comments on commit 792b438

Please sign in to comment.