updated documentation

Author: ttinoco

docs/conf.py

@@ -59,7 +59,7 @@
 
 # General information about the project.
 project = 'PFNET'
-copyright = '2018, Tomas Tinoco De Rubira'
+copyright = '2019, Tomas Tinoco De Rubira'
 author = 'Tomas Tinoco De Rubira'
 
 # The version info for the project you're documenting, acts as replacement for

docs/networks.rst

@@ -431,24 +431,22 @@ As explained above, once the network variables have been set, a vector with the
 Outages and Contingencies
 =========================
 
-PFNET provides a way to specify outages of certain components and analyze network contingencies. In particular, branches and generators can be set to be on outage. This can be done by setting their :data:`outage <pfnet.Generator.outage>` attribute to ``True``, as the next example shows::
+PFNET provides a way to set components out of service and analyze network contingencies. This can be done by setting the ``in_service`` attribute to ``False``, as the next example shows::
 
   >>> net = pfnet.PyParserMAT().parse('ieee14.m')
 
-  >>> net.clear_outages()
-
   >>> gen = net.get_generator(3)
   >>> branch = net.get_branch(2)
 
-  >>> gen.outage = True
-  >>> branch.outage = True
+  >>> gen.in_service = False
+  >>> branch.in_service = False
 
-  >>> print net.get_num_generators_on_outage(), net.get_num_branches_on_outage()
+  >>> print net.get_num_generators_out_of_service(), net.get_num_branches_out_of_service()
   1 1
 
 A contingency is represented by an object of type :class:`Contingency <pfnet.Contingency>`, and is characterized by one or more :class:`generator <pfnet.Generator>` or :class:`branch <pfnet.Branch>` outages. The lists of generator and branch outages of a contingency can be specified at construction, or by using the class methods :func:`add_generator_outage() <pfnet.Contingency.add_generator_outage>` and :func:`add_branch_outage() <pfnet.Contingency.add_branch_outage>`, respectively. The following example shows how to construct a contingency::
 
-  >>> net.clear_outages()
+  >>> net.make_all_in_service()
   
   >>> gen = net.get_generator(3)
   >>> branch = net.get_branch(2)
@@ -463,18 +461,18 @@ A contingency is represented by an object of type :class:`Contingency <pfnet.Con
 
 Once a contingency has been constructed, it can be applied and later cleared. This is done using the class methods :func:`apply() <pfnet.Contingency.apply>` and :func:`clear() <pfnet.Contingency.clear>`. The :func:`apply() <pfnet.Contingency.apply>` method sets the specified generator and branches on outage. The :func:`clear() <pfnet.Contingency.clear>` method undoes the changes made by the :func:`apply() <pfnet.Contingency.apply>` method. The following example shows how to apply and clear contingencies, and illustrates some of the side effects::
 
-  >>> print gen.is_on_outage(), branch.is_on_outage()
-  False False
+  >>> print gen.is_in_service(), branch.is_in_service()
+  True True
   
   >>> c1.apply(net)
 
-  >>> print gen.is_on_outage(), branch.is_on_outage()
-  True True
+  >>> print gen.is_in_service(), branch.is_in_service()
+  False False
 
   >>> c1.clear(net)
 
-  >>> print gen.is_on_outage(), branch.is_on_outage()
-  False False
+  >>> print gen.is_in_service(), branch.is_in_service()
+  True True
 
 More information about network contingencies can be found in the :ref:`API reference <ref_cont>`.
 
@@ -575,4 +573,4 @@ It is also possible to add and remove components to a network. This can be done
   >>> print len(bus.generators), len(bus.loads)
   1 1
   
-.. warning:: Making |Network| modifications programmatically is not yet guaranteed to be safe. One can easily leave out components with no bus connections, which could lead to errors in the underlying PFNET C library. Also, when adding or removing components from the network, the underlying PFNET C library copies existing data to new memory locations and hence any existing PFNET Python network components can point to invalid C memory locations. It is therefore recommended not to use existing PFNET Python network components adding or removing components of the same type from the network, but instead re-extract them from the updated network using :func:`get_bus() <pfnet.Network.get_bus>`, :func:`get_generator() <pfnet.Network.get_generator>`, etc.
+.. warning:: Making |Network| modifications programmatically is not yet guaranteed to be safe. One can easily leave out components with no bus connections, which could lead to errors in the underlying PFNET C library. Also, when adding or removing components from the network, the underlying PFNET C library copies existing data to new memory locations and hence any existing PFNET Python network components can point to invalid C memory locations. It is therefore recommended not to use existing PFNET Python network components after adding or removing components of the same type from the network, but instead re-extract them from the updated network using :func:`get_bus() <pfnet.Network.get_bus>`, :func:`get_generator() <pfnet.Network.get_generator>`, etc.

docs/problems.rst

@@ -288,7 +288,7 @@ The matrices and vectors associated with the linear constraints can be extracted
   0.042
   
   >>> bus = net.get_bus(5)
-  >>> Hi = constr.get_H_single(bus.index_P)
+  >>> Hi = constr.get_H_single(bus.dP_index)
 
   >>> print type(Hi), Hi.shape, Hi.nnz
   <class 'scipy.sparse.coo.coo_matrix'> (28, 28) 27
@@ -322,7 +322,7 @@ This constraint is associated with the string ``"AC power balance"``. It enforce
 
 where :math:`t` are time periods, :math:`P^g` and :math:`Q^g` are generator active and reactive powers, :math:`P^l` and :math:`Q^l` are load active and reactive powers, :math:`S^{sh}` are apparent powers flowing out of buses through shunt devices, :math:`S` are apparent powers flowing out of buses through branches, :math:`n` is the number of buses, :math:`T` is the number of time periods, and :math:`[n] := \{1,\ldots,n\}`. 
 
-The :class:`Bus <pfnet.Bus>` class attributes :data:`index_P <pfnet.Bus.index_P>` and :data:`index_Q <pfnet.Bus.index_Q>` can be used to obtain the row indices of the constraint function :data:`f <pfnet.ConstraintBase.f>` and Jacobian :data:`J <pfnet.ConstraintBase.J>` that are associated with the active and reactive power mismatches of a specific bus.
+The :class:`Bus <pfnet.Bus>` class attributes :data:`dP_index <pfnet.Bus.dP_index>` and :data:`dQ_index <pfnet.Bus.dQ_index>` can be used to obtain the row indices of the constraint function :data:`f <pfnet.ConstraintBase.f>` and Jacobian :data:`J <pfnet.ConstraintBase.J>` that are associated with the active and reactive power mismatches of a specific bus.
 
 .. _prob_constr_DCPF:
 
@@ -337,7 +337,7 @@ This constraint is associated with the string ``"DC power balance"``. It enforce
 
 where :math:`t` are time periods, :math:`P^g` are generator active powers, :math:`P^l` are load active powers, :math:`b_{km}` are branch susceptances, :math:`\theta_k` are bus voltage angles, :math:`\phi_{km}` are phase shifts of phase-shifting transformers, :math:`n` is the number of buses, :math:`T` is the number of time periods, and :math:`[n] := \{1,\ldots,n\}`.
 
-The :class:`Bus <pfnet.Bus>` class attribute :data:`index_P <pfnet.Bus.index_P>` can be used to obtain the row indices of the constraint matrix :data:`A <pfnet.ConstraintBase.A>` and right-hand-side :data:`b <pfnet.ConstraintBase.b>` that are associated with the active (DC) power mismatches of a specific bus.
+The :class:`Bus <pfnet.Bus>` class attribute :data:`dP_index <pfnet.Bus.dP_index>` can be used to obtain the row indices of the constraint matrix :data:`A <pfnet.ConstraintBase.A>` and right-hand-side :data:`b <pfnet.ConstraintBase.b>` that are associated with the active (DC) power mismatches of a specific bus.
 
 .. _prob_constr_LINPF: