Metadata-Version: 2.2
Name: power-grid-model-ds
Version: 0.0.1a11709467271
Summary: Power Grid Model extension which provides a grid data structure for simulation and analysis
Author-email: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
License: MPL-2.0
Project-URL: Home-page, https://lfenergy.org/projects/power-grid-model/
Project-URL: GitHub, https://github.com/PowerGridModel/power-grid-model-ds
Project-URL: Documentation, https://power-grid-model-ds.readthedocs.io/en/stable/
Project-URL: Mailing-list, https://lists.lfenergy.org/g/powergridmodel
Project-URL: Discussion, https://github.com/orgs/PowerGridModel/discussions
Keywords: power grid model
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: power-grid-model>=1.7
Requires-Dist: rustworkx>=0.15.1
Requires-Dist: numpy>=1.21
Provides-Extra: pandas
Requires-Dist: pandas>=2.2.1; extra == "pandas"
Provides-Extra: dev
Requires-Dist: pylint>=3.1.0; extra == "dev"
Requires-Dist: pytest>=8.1.1; extra == "dev"
Requires-Dist: coverage>=7.4.4; extra == "dev"
Requires-Dist: black>=24.3.0; extra == "dev"
Requires-Dist: ruff>=0.3.5; extra == "dev"
Requires-Dist: isort>=5.13.2; extra == "dev"
Requires-Dist: mypy>=1.9.0; extra == "dev"
Requires-Dist: pre-commit>=4; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: readthedocs-sphinx-search; extra == "docs"
Requires-Dist: sphinx-hoverxref; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"

<!--
SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>

SPDX-License-Identifier: MPL-2.0
-->

[![](https://github.com/PowerGridModel/.github/blob/main/artwork/svg/color.svg)](#)

# Power Grid Model Data Science (DS)

The Power Grid Model DS project extends the capabilities of the `power-grid-model` calculation core with a modelling and simulation interface. This is aimed at building data science software applications related to or using the power-grid-model project. It defines a `Grid` dataclass which manages the consistency of the complete network.

Some highlighted features:

- Using a model definition that corresponds to the power-grid-model, through
  which it is easy to do efficient grid calculations.
- The extended numpy model provides features which make development more
  pleasant and easy.
- Using the graph representation of the network, graph algorithms in rustworkx
  can be used to analyze the network.
- An interface to model network mutations which is useful in
  simulation use-cases.

## Installation

### Pip

```
pip install power-grid-model-ds
```

## Contributing

Please read [CODE_OF_CONDUCT](https://github.com/PowerGridModel/.github/blob/main/CODE_OF_CONDUCT.md) and [CONTRIBUTING](https://github.com/PowerGridModel/.github/blob/main/CONTRIBUTING.md) for details on the process 
for submitting pull requests to us.
