Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
veronicaguo committed Apr 10, 2019
1 parent 0ba5498 commit 6328436
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,6 @@ of the conductor for that phase.
# map of phases 'A', 'B', 'C' and 'N<>' which are described in the
# gmr, r and phase_positions attributes
z_primitive = CarsonsEquations(Line()).build_z_primitive()
z_abc = perform_kron_reduction(z_primitive)
line_impedance = impedance(CarsonsEquations(Line()))
Expand All @@ -94,6 +91,13 @@ including systems with multiple neutral cables; any phases that are not present
in the model will have zeros in the columns and rows corresponding to that
phase.

Intermediate results such as primitive impedance matrix are also available.

.. code:: python
z_primitive = CarsonsEquations(Line()).build_z_primitive()
z_abc = perform_kron_reduction(z_primitive)
Multiple neutrals are supported, as long as they have unique labels starting
with ``N`` (e.g. ``Neutral1``, ``Neutral2``).

Expand All @@ -103,7 +107,8 @@ For examples of how to use the model, see the `tests <https://github.com/opusone
`IEEE 4-bus test network <http://sites.ieee.org/pes-testfeeders/resources/>`_.


### Concentric Neutral Cable
Concentric Neutral Cable
~~~~~~~~~~~~~~~~~~~~~~~~

``carsons`` also supports modelling of concentric neutral cables of any phasings.
Its usage is very similar to the example above, only requires a few more
Expand Down Expand Up @@ -151,9 +156,6 @@ parameters about the neutral conductors in the line model object.
...
}
z_primitive = ConcentricNeutralCarsonsEquations(Line()).build_z_primitive()
z_abc = perform_kron_reduction(z_primitive)
line_impedance = impedance(ConcentricNeutralCarsonsEquations(Line()))
For examples of how to use the model, see the `tests <https://github.com/opusonesolutions/carsons/blob/master/tests/test_concentric_neutral_cable.py>`_.
Expand Down

0 comments on commit 6328436

Please sign in to comment.