.. PFNET documentation master file, created by
   sphinx-quickstart on Sat Feb 25 19:11:57 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PFNET C Library Documentation
=============================

Welcome! This is the documentation for the C library PFNET version |version|, last updated |today|.

**What is PFNET?** 

PFNET is a library for modeling and analyzing electric power networks. It provides data parsers, network analysis and manipulation routines, and fast and customizable constraint and objective function evaluators for constructing network optimization problems.

**License**

PFNET is released under the BSD 2-clause license.

**Interfaces**

* `Python <https://github.com/ttinoco/PFNET.py>`_ (complete)
* `Julia <https://github.com/ttinoco/PFNET.jl>`_ (early stage)
  
**Contents**

.. toctree::
   :numbered:
   :maxdepth: 3

   Getting Started<start>
   Source Code Reference (Doxygen) <http://pfnet.readthedocs.io/en/latest/c/>

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

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