.. image:: https://raw.githubusercontent.com/gteasoft/pypacity/master/docs/source/_images/pypacity_logo.png
   :alt: PyPacity
   :width: 300px
   :align: center


PyPacity
========


.. image:: https://github.com/gteasoft/pypacity/actions/workflows/docs.yml/badge.svg?branch=master
   :target: https://github.com/gteasoft/pypacity/actions/workflows/docs.yml
   :alt: Documentation build

.. image:: https://img.shields.io/badge/status-development-orange.svg
   :target: https://github.com/gteasoft/pypacity
   :alt: Development status

.. image:: https://img.shields.io/badge/license-GPL--3.0--only-blue.svg
   :target: https://github.com/gteasoft/pypacity/blob/master/LICENSE
   :alt: GPL-3.0-only License

.. |nbsp| unicode:: 0xA0
   :trim:

|nbsp|

**PyPacity** is a Python library for computing the ampacity of overhead electrical conductors.

It implements the IEEE 738 and CIGRE TB 601 methods under steady-state and transient conditions.

Requirements
------------

PyPacity requires Python 3.9 or newer.

Installation
------------

.. code-block:: console

   git clone https://github.com/gteasoft/pypacity
   cd pypacity
   pip install .

or    

.. code-block:: console

   python -m pip install pypacity



Documentation
-------------

The complete documentation includes the theoretical formulation,
input and output parameters, and application examples.

.. toctree::
   :maxdepth: 2
   :caption: Contents

   quickstart


.. image:: https://raw.githubusercontent.com/gteasoft/pypacity/master/docs/source/_images/UC_logo.png
   :alt: Universidad de Cantabria
   :width: 200px
   :align: center