ParameterGrid input documentation
=================================


Initialize parameter grid parameters.


Used to initialize class :class:`qimpy.transport.geometry.ParameterGrid`.

YAML template:
--------------

.. parsed-literal::

   :yamlparam:`qimpy.transport.geometry.ParameterGrid:shape`: [:yamltype:`int`]      :yamlcomment:`# Dimensions of parameter grid (always 2D).`
   :yamlparam:`qimpy.transport.geometry.ParameterGrid:dimension1`: :yamlkey:`null`  :yamlcomment:`# Parameter names and values to sweep along dimension 1.`
   :yamlparam:`qimpy.transport.geometry.ParameterGrid:dimension2`: :yamlkey:`null`  :yamlcomment:`# Parameter names and values to sweep along dimension 2.`
   :yamlparam:`qimpy.transport.geometry.ParameterGrid:save-rho`: :yamlkey:`no`      :yamlcomment:`# Whether to write the full density matrices to the checkpoint file.`

Parameters:
-----------

shape
+++++

*Type:* :yamltype:`int`

Dimensions of parameter grid (always 2D).

dimension1
++++++++++

*Type:* dict[str, dict[str, typing.Union[torch.Tensor, numpy.ndarray, float, typing.Sequence[float]]]] or :yamltype:`null`, *Default:*  :yamlkey:`null`

Parameter names and values to sweep along dimension 1.
The values can be specified with "loop" over explicit values,
or "sweep" linearly from the initial to the final value.

dimension2
++++++++++

*Type:* dict[str, dict[str, typing.Union[torch.Tensor, numpy.ndarray, float, typing.Sequence[float]]]] or :yamltype:`null`, *Default:*  :yamlkey:`null`

Parameter names and values to sweep along dimension 2.
Specification is the same as for `dimension1`.

save-rho
++++++++

*Type:* :yamltype:`bool`, *Default:*  :yamlkey:`no`

Whether to write the full density matrices to the checkpoint file.
If not (default), only observables are written to the checkpoint file.