@@ -123,7 +123,9 @@ def __init__(
123
123
Path to the batch folder to be used in the simulation. Export file
124
124
will be saved in this folder. Default is None.
125
125
export_sample_time : float, optional
126
- Sample time to downsample the arrays in seconds. Default is 0.1.
126
+ Sample time to downsample the arrays in seconds. Used to automatically
127
+ discretize inputs that contain callable ``rocketpy.Function`` objects.
128
+ Default is 0.1.
127
129
128
130
Returns
129
131
-------
@@ -196,8 +198,9 @@ def simulate(
196
198
parallel : bool, optional
197
199
If True, the simulations will be run in parallel. Default is False.
198
200
n_workers : int, optional
199
- Number of workers to be used. If None, the number of workers
200
- will be equal to the number of CPUs available. Default is None.
201
+ Number of workers to be used if ``parallel=True``. If None, the
202
+ number of workers will be equal to the number of CPUs available.
203
+ Default is None.
201
204
202
205
Returns
203
206
-------
@@ -1191,6 +1194,10 @@ def prepare_export_data(obj, sample_time=0.1, remove_functions=False):
1191
1194
----------
1192
1195
obj : object
1193
1196
The object whose attributes are to be inspected.
1197
+ sample_time : float, optional
1198
+ Time interval between samples. Default is 0.1.
1199
+ remove_functions : bool, optional
1200
+ If True, the Function objects will not be serialized. Default is False.
1194
1201
1195
1202
Returns
1196
1203
-------
0 commit comments