Updated docs

Author: rushad7

docs/_build/doctrees/environment.pickle

@@ -37,7 +37,9 @@ State Space Methods
    "`contr()`", "Controllability of the system"
    "`obs()`", "Observability of the system"
    "`stability()`", "Stability of the system"
-   "`eigplot(self, ret=True)`", "Plots eigenvalues/poles of system"
+   "`eigplot(ret=True)`", "Plots eigenvalues/poles of system"
+   "`StateResponse(t, initial_cond, u, ret=False, show=True)`", "Returns and plots state response"
+   "`OutputResponse(t, initial_cond, u, ret=False, show=True)`", "Returns and plots output response"
 
 System Connections
 *******************
@@ -59,15 +61,15 @@ Frequency Domain Analysis
    "`bode.freqresp(tf)`", "Returns the Frequency Response of the system"
    "`bode.bode(tf)`", "Returns the Bode Plot of the system"
 
-PID Control Design
-******************
+PID Controller Design
+**********************
 .. csv-table:: 
    :header: "Method", "Description"
    :widths: 40, 40
 
    "`PID(Kp, Ki, Kd, tf)`", "Creates a PID object"
    "`response(input_type, time_period=10, sample_time=0.05, ret=False, show=True)`", "Return the response of the system after PID control"
-   "`tune(input_type=""step"", set_point=1, num_itr=70, rate=0.00000000001)`", "Tune the PID coefficients"
+   "`tune(input_type=""step"", set_point=1, num_itr=70, rate=0.00000000001, lambd=0.7)`", "Tune the PID coefficients"
    "`display()`", "Display the PID block"
    "`reduced_tf`", "Displays the reduced Transfer Function (Controller + Plant)"
 

docs/_build/doctrees/ref.doctree

@@ -35,4 +35,4 @@ To define a system as Space State model, use the `StateSpace` class.
 
 Here, A,B,C,D are ndarrays.
 
-.. note:: Although you can define a system in any of the above form, few features are suited only for a particular representation. Therefore, if a particular method is needed and is not provided for the given system, you need to convert the system model first using the `convert2TF()` or `convert2SS()` method. Direct support for these methods will be added in a future update.
+.. note:: A system can be defined by any of the two representations above. If a particular method is needed but is not provided for the given system representation (which is unlikely), you can convert the system model to the desired representation using the `convert2TF()` or `convert2SS()` method. 

docs/_build/doctrees/rep.doctree

@@ -55,3 +55,5 @@
 [0627/191908.903:ERROR:crash_report_database_win.cc(428)] unexpected header
 [0627/192229.237:ERROR:crash_report_database_win.cc(428)] unexpected header
 [0627/194136.956:ERROR:crash_report_database_win.cc(428)] unexpected header
+[0706/193415.493:ERROR:crash_report_database_win.cc(428)] unexpected header
+[0706/194153.550:ERROR:crash_report_database_win.cc(428)] unexpected header

docs/_build/html/_sources/ref.rst.txt

@@ -88,7 +88,7 @@ <h1>Python Control Systems Toolbox<a class="headerlink" href="#python-control-sy
 <li class="toctree-l2"><a class="reference internal" href="ref.html#state-space-methods">State Space Methods</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ref.html#system-connections">System Connections</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ref.html#frequency-domain-analysis">Frequency Domain Analysis</a></li>
-<li class="toctree-l2"><a class="reference internal" href="ref.html#pid-control-design">PID Control Design</a></li>
+<li class="toctree-l2"><a class="reference internal" href="ref.html#pid-controller-design">PID Controller Design</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ref.html#state-feedback-design">State Feedback Design</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ref.html#state-observer-design">State Observer Design</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ref.html#linear-quadratic-regulator-lqr">Linear Quadratic Regulator(LQR)</a></li>

docs/_build/html/_sources/rep.rst.txt

@@ -125,9 +125,15 @@ <h2>State Space Methods<a class="headerlink" href="#state-space-methods" title="
 <tr class="row-even"><td><p><cite>stability()</cite></p></td>
 <td><p>Stability of the system</p></td>
 </tr>
-<tr class="row-odd"><td><p><cite>eigplot(self, ret=True)</cite></p></td>
+<tr class="row-odd"><td><p><cite>eigplot(ret=True)</cite></p></td>
 <td><p>Plots eigenvalues/poles of system</p></td>
 </tr>
+<tr class="row-even"><td><p><cite>StateResponse(t, initial_cond, u, ret=False, show=True)</cite></p></td>
+<td><p>Returns and plots state response</p></td>
+</tr>
+<tr class="row-odd"><td><p><cite>OutputResponse(t, initial_cond, u, ret=False, show=True)</cite></p></td>
+<td><p>Returns and plots output response</p></td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -178,8 +184,8 @@ <h2>Frequency Domain Analysis<a class="headerlink" href="#frequency-domain-analy
 </tbody>
 </table>
 </div>
-<div class="section" id="pid-control-design">
-<h2>PID Control Design<a class="headerlink" href="#pid-control-design" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="pid-controller-design">
+<h2>PID Controller Design<a class="headerlink" href="#pid-controller-design" title="Permalink to this headline">¶</a></h2>
 <table class="colwidths-given docutils align-default">
 <colgroup>
 <col style="width: 50%" />
@@ -197,7 +203,7 @@ <h2>PID Control Design<a class="headerlink" href="#pid-control-design" title="Pe
 <tr class="row-odd"><td><p><cite>response(input_type, time_period=10, sample_time=0.05, ret=False, show=True)</cite></p></td>
 <td><p>Return the response of the system after PID control</p></td>
 </tr>
-<tr class="row-even"><td><p><cite>tune(input_type=”step”, set_point=1, num_itr=70, rate=0.00000000001)</cite></p></td>
+<tr class="row-even"><td><p><cite>tune(input_type=”step”, set_point=1, num_itr=70, rate=0.00000000001, lambd=0.7)</cite></p></td>
 <td><p>Tune the PID coefficients</p></td>
 </tr>
 <tr class="row-odd"><td><p><cite>display()</cite></p></td>
@@ -329,7 +335,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 <li><a class="reference internal" href="#state-space-methods">State Space Methods</a></li>
 <li><a class="reference internal" href="#system-connections">System Connections</a></li>
 <li><a class="reference internal" href="#frequency-domain-analysis">Frequency Domain Analysis</a></li>
-<li><a class="reference internal" href="#pid-control-design">PID Control Design</a></li>
+<li><a class="reference internal" href="#pid-controller-design">PID Controller Design</a></li>
 <li><a class="reference internal" href="#state-feedback-design">State Feedback Design</a></li>
 <li><a class="reference internal" href="#state-observer-design">State Observer Design</a></li>
 <li><a class="reference internal" href="#linear-quadratic-regulator-lqr">Linear Quadratic Regulator(LQR)</a></li>

docs/_build/html/debug.log

@@ -72,7 +72,7 @@ <h2>State Space Models<a class="headerlink" href="#state-space-models" title="Pe
 <p>Here, A,B,C,D are ndarrays.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Although you can define a system in any of the above form, few features are suited only for a particular representation. Therefore, if a particular method is needed and is not provided for the given system, you need to convert the system model first using the <cite>convert2TF()</cite> or <cite>convert2SS()</cite> method. Direct support for these methods will be added in a future update.</p>
+<p>A system can be defined by any of the two representations above. If a particular method is needed but is not provided for the given system representation (which is unlikely), you can convert the system model to the desired representation using the <cite>convert2TF()</cite> or <cite>convert2SS()</cite> method.</p>
 </div>
 </div>
 </div>