From 792b4383714aa025f073cd89184cebbc96e11964 Mon Sep 17 00:00:00 2001 From: Juan Ospina Date: Wed, 22 Jun 2022 09:35:37 -0600 Subject: [PATCH] DOC: add PowerModelsITD logo and revised README.md (#7) --- CHANGELOG.md | 3 +- README.md | 34 +- docs/src/assets/logo.svg | 1418 ++++++++++++++++++++++++++++++++++++++ docs/src/index.md | 2 + 4 files changed, 1441 insertions(+), 16 deletions(-) create mode 100644 docs/src/assets/logo.svg diff --git a/CHANGELOG.md b/CHANGELOG.md index 8acb891..30c1e9c 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,8 @@ ## staged -- none. +- Added `PowerModelsITD` logo. +- Revised `README.md`. ## v0.7.2 diff --git a/README.md b/README.md index cbd7482..8930fbe 100755 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # PowerModelsITD.jl +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 @@ -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 @@ -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 diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg new file mode 100644 index 0000000..29503f6 --- /dev/null +++ b/docs/src/assets/logo.svg @@ -0,0 +1,1418 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Power Models + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/src/index.md b/docs/src/index.md index e1d1ec1..e82e57a 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,3 +1,5 @@ +![PowerModelsITD Logo](assets/logo.svg) +=== ```@meta CurrentModule = PowerModelsITD