.. PyRC documentation master file, created by Joel Kimmich

PyRC Documentation
==================

Welcome on the PyRC documentation site. You can find the source code on `Codeberg <https://codeberg.org/IGTE/pyrc>`_.

If you don't know where to start, look at the Examples.

Important Classes
-----------------

.. grid:: 1 1 2 2
    :gutter: 2 3 4 4

    .. grid-item-card::
        :text-align: center

        Examples
        ^^^

        Worked examples showing how to use PyRC for building and solving RC networks.

        +++

        .. button-ref:: auto_examples/index
            :expand:
            :color: secondary
            :click-parent:

            Examples gallery

    .. grid-item-card::
        :text-align: center

        RCNetwork
        ^^^

        The parent class of all Networks containing the abstract method `_create_network` and
        the method to create the solution: `solve_network`\.

        +++

        .. button-ref:: pyrc.core.network.RCNetwork
            :expand:
            :color: secondary
            :click-parent:

            Network parent class

    .. grid-item-card::
        :text-align: center

        Resistor
        ^^^

        This class holds the `resistance` property generating the resistance value automatically.
        It is used as parent for the other `Resistor`\s like `CombinedResistor`\,
        `MassTransport`\, `HeatConduction` and `HeatTransfer`\.

        +++

        .. button-ref:: pyrc.core.components.resistor.Resistor
            :expand:
            :color: secondary
            :click-parent:

            Main Resistor class

    .. grid-item-card::
        :text-align: center

        Capacitor
        ^^^

        This class holds the `capacity` property with a defined `temperature`\.

        +++

        .. button-ref:: pyrc.core.components.capacitor.Capacitor
            :expand:
            :color: secondary
            :click-parent:

            Main Capacitor class

    .. grid-item-card::
        :text-align: center

        Node
        ^^^

        A Node has -- contrary to a `Capacitor` -- a defined position and length, width and height (volume) and
        material.
        But it is still just a node but with more information for the algorithms.

        +++

        .. button-ref:: pyrc.core.nodes.Node
            :expand:
            :color: secondary
            :click-parent:

            Main Node class (with position and volume)


Content
-------

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

    auto_examples/index
    changelog
    contributing
    pyrc

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`