Skip to content

Commit e236d95

Browse files
committed
add BH to docs
1 parent 1ae4468 commit e236d95

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

econpizza/solvers/shooting.py

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,24 @@ def find_path_shooting(
4242
shock : tuple, optional
4343
shock in period 0 as in `(shock_name_as_str, shock_size)`
4444
horizon : int, optional
45-
number of periods to simulate
45+
number of periods to actually simulate. This is NOT the expectations horizon of agents. Defaults to 30
4646
init_path : array, optional
47-
a first guess on the trajectory. Normally not necessary
47+
an initial guess on the trajectory. This should not be necessary
4848
max_horizon : int, optional
49-
number of periods until the system is assumed to be back in the steady state. A good idea to set this corresponding to the respective problem. Note that a horizon too far away may cause the accumulation of numerical errors.
49+
number of periods until the system is assumed to be back in the steady state. A good idea to set this corresponding to the respective problem. Note that a horizon too far away may cause the accumulation of numerical errors. Defaults to 200
5050
max_loops : int, optional
51-
number of repetitions to iterate over the whole trajectory. Should eventually be high.
52-
max_iterations : int, optional
53-
number of iterations. Default is `max_horizon`. It should not be lower than that (and will raise an error). Normally it should not be higher, better use `max_loops` instead.
51+
number of repetitions to iterate over the whole trajectory. Should eventually be high. Defaults to 100
52+
max_iter : int, optional
53+
number of iterations. Defaults to `max_horizon`. It should not be lower than that (and will raise an error). Normally it should not be higher, better use `max_loops` instead.
5454
tol : float, optional
55-
convergence criterion
55+
convergence criterion, defaults to `1e-5`
5656
verbose : bool, optional
57-
degree of verbosity. 0/`False` is silent
57+
degree of verbosity. 0/`False` is silent. Defualts to `True`
5858
5959
Returns
6060
-------
6161
x_fin : array
6262
array of the trajectory
63-
x_lin : array or None
64-
array of the trajectory based on the linear model. Will return None if the linear model is unknown
6563
fin_flag : int
6664
error code
6765
"""

0 commit comments

Comments
 (0)