Merge pull request #36 from opusonesolutions/document_units

Update README To Document Units

Author: etimberg

README.md

@@ -54,11 +54,11 @@ from carsons import CarsonsEquations, calculate_impedance
 
 class Line:
    geometric_mean_radius: {
-       'A': geometric_mean_radius_A
+       'A': geometric_mean_radius_A in meters
        ...
    }
    resistance: {
-        'A': per-length resistance of conductor A in ohms
+        'A': per-length resistance of conductor A in ohms/meters
         ...
    }
    wire_positions: {
@@ -105,42 +105,42 @@ object.
 from carsons import (ConcentricNeutralCarsonsEquations,
                      calculate_impedance)
 
-class Line:
+class Cable:
    resistance: {
-       'A': per-length resistance of conductor A in ohms
+       'A': per-length resistance of conductor A in ohm/meters
        ...
    }
    geometric_mean_radius: {
-       'A': geometric_mean_radius_A
+       'A': geometric mean radius of conductor A in meters
        ...
    }
    wire_positions: {
-        'A': (x, y) cross-sectional position of the conductor in meters
+        'A': (x, y) cross-sectional position of conductor A in meters
         ...
    }
    phases: {'A', 'NA', ... }
    neutral_strand_gmr: {
-       'NA': neutral_strand_gmr_A
+       'NA': neutral strand gmr of phase A in meters
        ...
    }
    neutral_strand_resistance: {
-       'NA': neutral_strand_resistance_A
+       'NA': neutral strand resistance of phase A in ohm/meters
        ...
    }
    neutral_strand_diameter: {
-       'NA': neutral_strand_diameter_A
+       'NA': neutral strand diameter of phase A in meters
        ...
    }
    diameter_over_neutral: {
-       'NA': diameter_over_neutral_A
+       'NA': diameter over neutral of phase A in meters
        ...
    }
    neutral_strand_count: {
-       'NA': neutral_strand_count_A
+       'NA': neutral strand count of phase A
        ...
    }
 
-line_impedance = calculate_impedance(ConcentricNeutralCarsonsEquations(Line()))
+cable_impedance = calculate_impedance(ConcentricNeutralCarsonsEquations(Cable()))
 ```
 
 For examples of how to use the model, see the [concentric cable