isofit.__main__
===============

.. py:module:: isofit.__main__

.. autoapi-nested-parse::

   ISOFIT command line interface.



Classes
-------

.. autoapisummary::

   isofit.__main__.CLI


Functions
---------

.. autoapisummary::

   isofit.__main__.cli


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

.. py:class:: CLI(*args, lazy_subcommands=None, **kwargs)

   Bases: :py:obj:`click.Group`


   Custom click class to load commands at runtime. This enables optional, external
   subcommands (such as isoplots) to be inserted into the sys path.

   Reference: https://click.palletsprojects.com/en/stable/complex/#defining-the-lazy-group


   .. py:attribute:: laziest
      :value: False



   .. py:attribute:: lazy


   .. py:method:: main(*args, **kwargs)

      Loads the default ini and checks for the cli_laziest before shell tab
      completion, which may speed it up



   .. py:method:: invoke(ctx)

      Loads the ISOFIT ini into env and applies any overrides before invoking any
      subcommands

      :param ctx: The Click context
      :type ctx: click.Context



   .. py:method:: list_commands(ctx)

      List the names of available commands

      :param ctx: The Click context
      :type ctx: click.Context

      :returns: The names of available lazy-loaded commands
      :rtype: list of str



   .. py:method:: resolve(cmd_name)

      Resolves the import of a click function from a module string

      The import path to a Click command is to be in the format 'module:function'
      If 'function' is not provided, defaults seeking for a function named 'cli'

      :param cmd_name: Command to retrieve
      :type cmd_name: str

      :returns: Resulting Click function imported from a module
      :rtype: function



   .. py:method:: get_command(ctx, cmd_name)

      Get a lazily-loaded command by name

      :param ctx: The Click context
      :type ctx: click.Context
      :param cmd_name: Name of the command to retrieve
      :type cmd_name: str

      :returns: The command object or None if not found
      :rtype: click.Command or None



.. py:function:: cli(ctx, version, help, **kwargs)

   ISOFIT contains a set of routines and utilities for fitting surface, atmosphere and instrument models to imaging spectrometer data.

   
   Repository: https://github.com/isofit/isofit
   Documentation: https://isofit.readthedocs.io/en/latest
   Report an issue: https://github.com/isofit/isofit/issues