|
4038 | 4038 | "fastsim._fastsim.Block" |
4039 | 4039 | ], |
4040 | 4040 | "methods": [ |
| 4041 | + { |
| 4042 | + "name": "read", |
| 4043 | + "description": "Recorded times and per-port data.", |
| 4044 | + "docstring_html": "<p>Recorded times and per-port data.</p>\n<p>Returns <tt class=\"docutils literal\">(time, data)</tt> with <cite>data</cite> an array of shape\n<tt class=\"docutils literal\">(n_ports, n_samples)</tt>, and <tt class=\"docutils literal\">(None, None)</tt> when nothing was\nrecorded — both as in pathsim, whose examples do array arithmetic on\nthe result (<tt class=\"docutils literal\">data_moon - data_earth</tt>) and test the empty case with\n<tt class=\"docutils literal\">if time is None</tt>.</p>\n", |
| 4045 | + "source": null, |
| 4046 | + "signature": "(args = (), kwargs = {})", |
| 4047 | + "parameters": [ |
| 4048 | + { |
| 4049 | + "name": "args", |
| 4050 | + "type": null, |
| 4051 | + "default": "()", |
| 4052 | + "description": "" |
| 4053 | + }, |
| 4054 | + { |
| 4055 | + "name": "kwargs", |
| 4056 | + "type": null, |
| 4057 | + "default": "{}", |
| 4058 | + "description": "" |
| 4059 | + } |
| 4060 | + ], |
| 4061 | + "returns": null, |
| 4062 | + "method_type": "method" |
| 4063 | + }, |
4041 | 4064 | { |
4042 | 4065 | "name": "plot", |
4043 | | - "description": "Plot recorded data with interactive legend picking.", |
4044 | | - "docstring_html": "<p>Plot recorded data with interactive legend picking.</p>\n", |
| 4066 | + "description": "Plot every recorded port against time.", |
| 4067 | + "docstring_html": "<p>Plot every recorded port against time.</p>\n", |
4045 | 4068 | "source": null, |
4046 | 4069 | "signature": "(args = (), kwargs = {})", |
4047 | 4070 | "parameters": [ |
|
4060 | 4083 | ], |
4061 | 4084 | "returns": null, |
4062 | 4085 | "method_type": "method" |
| 4086 | + }, |
| 4087 | + { |
| 4088 | + "name": "plot2D", |
| 4089 | + "description": "Plot one recorded port against another (a phase portrait).", |
| 4090 | + "docstring_html": "<p>Plot one recorded port against another (a phase portrait).</p>\n", |
| 4091 | + "source": null, |
| 4092 | + "signature": "(args = (), axes = (0, 1), kwargs = {})", |
| 4093 | + "parameters": [ |
| 4094 | + { |
| 4095 | + "name": "args", |
| 4096 | + "type": null, |
| 4097 | + "default": "()", |
| 4098 | + "description": "" |
| 4099 | + }, |
| 4100 | + { |
| 4101 | + "name": "axes", |
| 4102 | + "type": null, |
| 4103 | + "default": "(0, 1)", |
| 4104 | + "description": "" |
| 4105 | + }, |
| 4106 | + { |
| 4107 | + "name": "kwargs", |
| 4108 | + "type": null, |
| 4109 | + "default": "{}", |
| 4110 | + "description": "" |
| 4111 | + } |
| 4112 | + ], |
| 4113 | + "returns": null, |
| 4114 | + "method_type": "method" |
| 4115 | + }, |
| 4116 | + { |
| 4117 | + "name": "plot3D", |
| 4118 | + "description": "Plot three recorded ports against each other.", |
| 4119 | + "docstring_html": "<p>Plot three recorded ports against each other.</p>\n", |
| 4120 | + "source": null, |
| 4121 | + "signature": "(args = (), axes = (0, 1, 2), kwargs = {})", |
| 4122 | + "parameters": [ |
| 4123 | + { |
| 4124 | + "name": "args", |
| 4125 | + "type": null, |
| 4126 | + "default": "()", |
| 4127 | + "description": "" |
| 4128 | + }, |
| 4129 | + { |
| 4130 | + "name": "axes", |
| 4131 | + "type": null, |
| 4132 | + "default": "(0, 1, 2)", |
| 4133 | + "description": "" |
| 4134 | + }, |
| 4135 | + { |
| 4136 | + "name": "kwargs", |
| 4137 | + "type": null, |
| 4138 | + "default": "{}", |
| 4139 | + "description": "" |
| 4140 | + } |
| 4141 | + ], |
| 4142 | + "returns": null, |
| 4143 | + "method_type": "method" |
4063 | 4144 | } |
4064 | 4145 | ], |
4065 | 4146 | "attributes": [], |
|
4095 | 4176 | "methods": [ |
4096 | 4177 | { |
4097 | 4178 | "name": "plot", |
4098 | | - "description": "Plot frequency spectrum with interactive legend picking.", |
4099 | | - "docstring_html": "<p>Plot frequency spectrum with interactive legend picking.</p>\n", |
| 4179 | + "description": "Plot the magnitude of every recorded spectrum.", |
| 4180 | + "docstring_html": "<p>Plot the magnitude of every recorded spectrum.</p>\n<p>Keeps the figure and axis on the block (<tt class=\"docutils literal\">self.fig</tt> / <tt class=\"docutils literal\">self.ax</tt>) as\npathsim does, so a caller can adjust the plot afterwards —\n<tt class=\"docutils literal\"><span class=\"pre\">Spc.ax.set_yscale("log")</span></tt> in pathsim's <tt class=\"docutils literal\">example_noise.py</tt>.</p>\n", |
4100 | 4181 | "source": null, |
4101 | 4182 | "signature": "(args = (), kwargs = {})", |
4102 | 4183 | "parameters": [ |
|
9377 | 9458 | ], |
9378 | 9459 | "functions": [] |
9379 | 9460 | }, |
| 9461 | + "fastsim.blocks._outputs": { |
| 9462 | + "name": "fastsim.blocks._outputs", |
| 9463 | + "description": "", |
| 9464 | + "docstring_html": "", |
| 9465 | + "classes": [ |
| 9466 | + { |
| 9467 | + "name": "OutputRegister", |
| 9468 | + "description": "A block's outputs as an ndarray; item assignment writes through.", |
| 9469 | + "docstring_html": "<p>A block's outputs as an ndarray; item assignment writes through.</p>\n<p>Indexing past the end grows the register, as pathsim's <cite>Register</cite> does —\nwhich is why an out-of-range index is forwarded to the block instead of\nbeing rejected by numpy's bounds check.</p>\n", |
| 9470 | + "source": null, |
| 9471 | + "bases": [ |
| 9472 | + "numpy.ndarray" |
| 9473 | + ], |
| 9474 | + "methods": [], |
| 9475 | + "attributes": [], |
| 9476 | + "parameters": [] |
| 9477 | + } |
| 9478 | + ], |
| 9479 | + "functions": [] |
| 9480 | + }, |
9380 | 9481 | "fastsim.blocks._shim": { |
9381 | 9482 | "name": "fastsim.blocks._shim", |
9382 | 9483 | "description": "", |
|
9804 | 9905 | "attributes": [], |
9805 | 9906 | "parameters": [] |
9806 | 9907 | }, |
| 9908 | + { |
| 9909 | + "name": "ESDIRK85", |
| 9910 | + "description": "Explicit-first-stage Singly Diagonally Implicit Runge-Kutta embedded pair, orders 8 and 5, for adaptive step-size control.", |
| 9911 | + "docstring_html": "<p>Explicit-first-stage Singly Diagonally Implicit Runge-Kutta embedded pair, orders 8 and 5, for adaptive step-size control. Sixteen stages, L-stable and stiffly accurate. Very expensive (15 implicit solves per step) — for stiff reference solutions at tight tolerances; ESDIRK54 is the better general choice.</p>\n", |
| 9912 | + "source": null, |
| 9913 | + "bases": [ |
| 9914 | + "fastsim._fastsim.ESDIRK85" |
| 9915 | + ], |
| 9916 | + "methods": [], |
| 9917 | + "attributes": [], |
| 9918 | + "parameters": [] |
| 9919 | + }, |
9807 | 9920 | { |
9808 | 9921 | "name": "GEAR52A", |
9809 | 9922 | "description": "Gear-type backward differentiation formula (BDF) with adaptive order (up to 5) and adaptive step size.", |
|
0 commit comments