pyextal.jaxJoint.cli
====================

.. py:module:: pyextal.jaxJoint.cli

.. autoapi-nested-parse::

   Command line for `jaxJoint.refine.refine`.

   Every `jaxGeo` option is accepted and applies to all datasets; ``--h5`` and
   ``--dat`` take one value per dataset. A script lists its datasets, with any
   per-dataset options, and keeps the whole command line::

       from pyextal.jaxJoint import cli
       raise SystemExit(cli.main(doc=__doc__,
                                 datasets=[dict(h5=R5), dict(h5=R4, subsample=2)],
                                 steps=800, tile=180))

   An option given on the command line overrides the script's per-dataset values
   for every dataset; ``--h5`` replaces the script's list of datasets.



Attributes
----------

.. autoapisummary::

   pyextal.jaxJoint.cli.WEIGHTINGS


Functions
---------

.. autoapisummary::

   pyextal.jaxJoint.cli.build_parser
   pyextal.jaxJoint.cli.main


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

.. py:data:: WEIGHTINGS
   :value: ('pixels', 'equal')


.. py:function:: build_parser(defaults=None, doc=None, weighting='pixels', out_dir=None)

   The argument parser: `jaxGeo`'s options plus the joint ones.

   :param defaults: Supplies every common default.
   :type defaults: RefineSettings, optional
   :param doc: Text printed by ``--help`` before the method.
   :type doc: str, optional
   :param weighting: Defaults of the joint options.
   :param out_dir: Defaults of the joint options.

   :returns: argparse.ArgumentParser


.. py:function:: main(argv=None, doc=None, datasets=None, names=None, weighting='pixels', out_dir=None, **defaults)

   Parses the command line and runs the joint 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 datasets: One entry per dataset: a dict of options
                    that differ from the common ones (at least ``h5``), or a path.
   :type datasets: list, optional
   :param names: Display names.
   :type names: list, optional
   :param weighting: ``'pixels'``, ``'equal'`` or one weight per dataset.
   :param out_dir: Where the joint summary goes.
   :type out_dir: Path, optional
   :param \*\*defaults: Common `RefineSettings` fields.

   :returns: 0 on success, 1 if any dataset's final simulation failed.
   :rtype: int