pyextal.jaxGeo.cli
==================

.. py:module:: pyextal.jaxGeo.cli

.. autoapi-nested-parse::

   Command line for `jaxGeo.refine.refine`.

   Every option's default comes from a `RefineSettings`, so a dataset script sets
   its own defaults and keeps the whole command line::

       from pyextal.jaxGeo import cli
       raise SystemExit(cli.main(doc=__doc__, h5=H5, tile=16, geo_max_block=12.0))

   ``python <script> --help`` then prints the script's docstring, the method, and
   every option with the script's defaults.



Functions
---------

.. autoapisummary::

   pyextal.jaxGeo.cli._path_or_none
   pyextal.jaxGeo.cli.build_parser
   pyextal.jaxGeo.cli.main


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

.. py:function:: _path_or_none(text)

.. py:function:: build_parser(defaults=None, doc=None)

   The argument parser, with defaults taken from ``defaults``.

   :param defaults: Supplies every default.
   :type defaults: RefineSettings, optional
   :param doc: Text printed by ``--help`` before the method.
   :type doc: str, optional

   :returns: argparse.ArgumentParser


.. py:function:: main(argv=None, doc=None, **defaults)

   Parses the command line and runs the refinement.

   :param argv: Arguments; ``sys.argv[1:]`` when None.
   :type argv: list, optional
   :param doc: The calling script's docstring, for ``--help``.
   :type doc: str, optional
   :param \*\*defaults: `RefineSettings` fields to use as defaults.

   :returns: Exit code -- 0 on success, 1 if the simulation after the
             refinement failed (the parameters are then in a rescue ``.npz``).
   :rtype: int