line_flow pfnet documentation ready

ttinoco · ttinoco · commit 51eec61d4ca0 · 2017-05-18T16:22:31.000+02:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,8 +18,13 @@ PFNET is released under the BSD 2-clause license.
 
 **Wrappers**
 
-* `Python <http://pfnet-python.readthedocs.io/>`_
-* Matlab (getting started)
+* `Python <https://github.com/ttinoco/PFNET/tree/line_flow_lib/python>`_
+
+  * `Tutorial and Documentation <http://pfnet-python.readthedocs.io/>`_
+
+* `Matlab <https://github.com/ttinoco/PFNET/tree/line_flow_lib/matlab>`_ 
+
+  * just started, help needed
 
 **Documentation Contents**
 
diff --git a/docs/start.rst b/docs/start.rst
@@ -11,8 +11,9 @@ Dependencies
 
 The PFNET C library has the following optional dependencies:
 
-* `Graphviz`_ (libgvc >= 2.38)
-* Raw parser (libraw_parser >= 1.2.3)
+* `Graphviz`_ (libgvc >= 2.38): for creating network layouts and visualizing networks.
+* Raw Parser (libraw_parser >= 1.2.3) : for parsing PSSE raw files.
+* Line Flow (libline_flow): for constructing linear conservative AC branch flow limits.
 
 .. _start_download:
 
@@ -34,7 +35,7 @@ Installing PFNET requires typing the following commands in the root directory of
   make check
   sudo make install
 
-If raw parser is available, the library should be placed in the ``lib`` directory. 
+If ``Raw Parser`` is available, the library should be placed in the ``lib`` directory of PFNET. If ``Line Flow`` is available, the environment variable ``LINE_FLOW`` should be defined so that the library can be located in the directory ``$LINE_FLOW/lib``.
 
 .. _start_docs:
 
diff --git a/python/docs/problems.rst b/python/docs/problems.rst
@@ -339,7 +339,14 @@ for each branch :math:`(k,m)`, where :math:`b_{km}` are branch susceptances, :ma
 AC branch flow limits
 ---------------------
 
-This constraint is associated with the string ``"AC branch flow limits"``. It enforces branch "AC" power flow limits due to thermal ratings using current magnitudes. This constraint utilizes auxiliary variables, which are also supported in PFNET and will be documented soon. 
+This constraint is associated with the string ``"AC branch flow limits"``. It enforces branch "AC" power flow limits due to thermal ratings based on current magnitudes. It utilizes auxiliary variables (slacks). 
+
+.. _prob_constr_AC_LIN_FLOW_LIM:
+
+Linearized AC branch flow limits
+--------------------------------
+
+This constraint is associated with the string ``"linearized AC branch flow limits"``. It enforces branch "AC" power flow limits due to thermal ratings based on current magnitudes using conservative linear constraints constructed with the external library ``Line Flow`` [DS2017]_. This external library is used with its default parameters.
 
 .. _prob_constr_FIX:
 
diff --git a/python/docs/reference.rst b/python/docs/reference.rst
@@ -495,6 +495,7 @@ Constraint Names
 ``"voltage regulation by shunts"``
 ``"AC branch flow limits"``
 ``"DC branch flow limits"``
+``"linearized AC branch flow limits"``
 ``"battery dynamics"``
 ``"load constant power factor"``
 ============================================ =======
@@ -525,10 +526,11 @@ Problem Class
    :members:
    :exclude-members: add_heuristic, apply_heuristics
 
-.. _ref_references:
+.. _ref_papers:
 
-References
-==========
+Papers
+======
 
-.. [TTR2015] T\. Tinoco De Rubira, *Numerical Optimization and Modeling Techniques for Power System Operations and Planning*. PhD thesis, Stanford University, March 2015.
+.. [DS2017] D\. Shchetinin, T\. Tinoco De Rubira, G\. Hug, *Conservative Linear Line Flow Constraints for AC Optimal Power Flow*, IEEE PES Powertech Conference, June 2017.
 
+.. [TTR2015] T\. Tinoco De Rubira, *Numerical Optimization and Modeling Techniques for Power System Operations and Planning*. PhD thesis, Stanford University, March 2015.
diff --git a/python/docs/start.rst b/python/docs/start.rst
@@ -44,7 +44,7 @@ The availability of optional features of PFNET can be checked using::
 
   >>> import pfnet
   >>> pfnet.info
-  {'raw parser': False, 'graphviz': True}
+  {'line_flow': True, 'raw_parser': True, 'graphviz': True}
 
 .. _start_example:
 
diff --git a/python/pfnet/cprob.pyx b/python/pfnet/cprob.pyx
@@ -33,7 +33,7 @@ cdef class Problem:
 
         Parameters
         ----------
-        net : :class:`Network <pfnet.Network>'
+        net : :class:`Network <pfnet.Network>`
         """
 
         pass
