scipy / std¶
Description¶
The present pluginis based on the python package plugin. Therein, the function scipy.optimze.minimize is used. See details on the function here
Yaml arguments¶
The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:
Mandatory arguments¶
method: (mandatory)
Type of solver.
accepted type: str
Optional arguments¶
maxiter: (optional)
Maximum number of iterations
accepted type: int
maxfun: (optional)
Maximum number of function evaluation
accepted type: int
epsg: (optional)
Condition on the norm of the gradient. Converges if ||g||_k < epsg . ||g||_0
accepted type: float
Requirements¶
The current plugin requires the present plugins to run properly:
Requirement name |
Requirement type |
Explicit definition |
Any valid |
Default name |
Default version |
|---|---|---|---|---|---|
simulator |
True |
True |
gausscost |
std |
Yaml template¶
Please find below a template for a Yaml configuration:
1minimizer:
2 plugin:
3 name: scipy
4 version: std
5 type: minimizer
6
7 # Mandatory arguments
8 method: XXXXX # str
9
10 # Optional arguments
11 maxiter: XXXXX # int
12 maxfun: XXXXX # int
13 epsg: XXXXX # float
