GitHub

PowerNetworkMatrices.jl

Overview

PowerNetworkMatrices.jl is a Julia package for the evaluation of network matrices given the system's data. The package allows to compute the matrices according to different methods, providing a flexible and powerful tool.

PowerNetworkMatrices.jl is an active project under development, and we welcome your feedback, suggestions, and bug reports.

Documentation Structure

PowerNetworkMatrices.jl strives to follow the Diataxis documentation framework, which organizes documentation according to the different needs of users. The documentation is structured into four main sections:

Tutorials

Learning-oriented guides to help you get started

Tutorials are hands-on lessons that take you through practical examples step-by-step. They are designed to help you learn by doing, building understanding through practical experience.

  • Start here if you're new to PowerNetworkMatrices.jl
  • Follow along with executable examples
  • Build foundational knowledge

How-To Guides

Task-oriented guides for accomplishing specific goals

How-to guides provide direct instructions for solving specific problems or completing particular tasks. They assume you have basic knowledge and want to accomplish something specific.

  • Use when you know what you want to do
  • Get straight to the solution
  • Focus on practical application

Explanation

Understanding-oriented discussion of key topics

Explanations provide background, context, and deeper understanding of concepts, design decisions, and the theory behind the implementation.

  • Understand the "why" behind the features
  • Learn about the mathematical foundations
  • Explore conceptual relationships

Reference

Information-oriented technical descriptions

Reference documentation provides detailed, technical information about the API, functions, and data structures. It's organized for quick lookup of specific details.

  • Look up function signatures and parameters

  • Find available methods and options

  • Access complete API documentation

PowerNetworkMatrices has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Laboratory of the Rockies (formerly known as NREL) (NLR).