pencil.read.params
==================

.. py:module:: pencil.read.params

.. autoapi-nested-parse::

   Contains the parameters of the simulation.



Attributes
----------

.. autoapisummary::

   pencil.read.params.lnml


Classes
-------

.. autoapisummary::

   pencil.read.params.Param


Functions
---------

.. autoapisummary::

   pencil.read.params.param


Module Contents
---------------

.. py:data:: lnml
   :value: True


.. py:class:: Param

   Bases: :py:obj:`pencil.util.DotDict`


   Param -- holds the simulation parameters.


   .. py:method:: read(datadir='data', param1=False, param2=False, quiet=True, conflicts_quiet=True, asdict=True, nest_dict=True, append_units=True, keep_nested=False)

      read(datadir='data', param1=False, param2=False, quiet=True,
           conflicts_quiet=False, asdict=True, nest_dict=True, append_units=True)

      Read Pencil Code simulation parameters.
      Requires: nl2python perl script (based on Wolfgang Dobler's nl2idl script).

      :param datadir: Directory where the data is stored.
      :type datadir: string
      :param param1: Selects the set of parameters only from start.
      :type param1: bool
      :param param2: Selects the set of parameters only from run.
                     If neither Param1 nor Param2 is set, both param.nml and param2.nml are read in.
      :type param2: bool
      :param quiet: Flag for switching of output.
      :type quiet: bool
      :param conflicts_quiet: Flag for switching off printing duplicate labels.
      :type conflicts_quiet: bool
      :param asdict: Reads parameters as dictionary.
      :type asdict: bool
      :param nest_dict: Reads parameters as nested dictionary.
      :type nest_dict: bool
      :param append_units: Derives dimensional units from standard code units.
      :type append_units: bool
      :param keep_nested: Whether to keep the attributes corresponding to individual namelist. If True, self.XXX will contain the entries from XXX_run_pars. Requires nest_dict=True.
      :type keep_nested: bool

      :returns: * *Instance of the pencil.read.param.Param class.*
                * *All of the selected parameters are imported as class members.*



.. py:function:: param(*args, **kwargs)

   Wrapper for :py:meth:`Param.read`