isofit.data.cli.isoplots
========================

.. py:module:: isofit.data.cli.isoplots

.. autoapi-nested-parse::

   Downloads the extra ISOFIT plotting utilities from the repository https://github.com/isofit/isofit-plots



Attributes
----------

.. autoapisummary::

   isofit.data.cli.isoplots.CMD


Functions
---------

.. autoapisummary::

   isofit.data.cli.isoplots.install
   isofit.data.cli.isoplots.download
   isofit.data.cli.isoplots.validate
   isofit.data.cli.isoplots.isUpToDate
   isofit.data.cli.isoplots.update
   isofit.data.cli.isoplots.download_cli
   isofit.data.cli.isoplots.validate_cli


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

.. py:data:: CMD
   :value: 'plots'


.. py:function:: install(path=None)

   Installs a python package into the current python environment as editable mode

   :param path: Path to package to install. If None, defaults to the ini path
   :type path: str | None


.. py:function:: download(path=None, tag='latest', overwrite=False)

   Downloads the extra ISOFIT plotting utilities from the repository https://github.com/isofit/isofit-plots.

   :param path: Path to output as. If None, defaults to the ini path
   :type path: str | None
   :param tag: Release tag to pull from the github
   :type tag: str
   :param overwrite: Overwrite an existing installation
   :type overwrite: bool, default=False


.. py:function:: validate(path=None, checkForUpdate=True, debug=print, error=print, **_)

   Validates an isoplots installation

   :param path: Path to verify. If None, defaults to the ini path
   :type path: str, default=None
   :param checkForUpdate: Checks for updates if the path is valid
   :type checkForUpdate: bool, default=True
   :param debug: Print function to use for debug messages, eg. logging.debug
   :type debug: function, default=print
   :param error: Print function to use for error messages, eg. logging.error
   :type error: function, default=print
   :param \*\*_: Ignores unused params that may be used by other validate functions. This is to
                 maintain compatibility with env.validate
   :type \*\*_: dict

   :returns: True if valid, False otherwise
   :rtype: bool


.. py:function:: isUpToDate(path=None, tag='latest', debug=print, error=print, **_)

   Checks the installed version against the latest release

   :param path: Path to update. If None, defaults to the ini path
   :type path: str, default=None
   :param debug: Print function to use for debug messages, eg. logging.debug
   :type debug: function, default=print
   :param error: Print function to use for error messages, eg. logging.error
   :type error: function, default=print
   :param _: Ignores unused params that may be used by other validate functions. This is to
             maintain compatibility with other functions
   :type _: dict

   :returns: True if the path is up to date, False otherwise
   :rtype: bool

   .. rubric:: Notes

   The Github workflows watch for the string "[x]" to determine if the cache needs to
   update the data of this module. If your module does not include this string, the
   workflows will never detect updates.


.. py:function:: update(check=False, **kwargs)

   Checks for an update and executes a new download if it is needed

   :param check: Just check if an update is available, do not download
   :type check: bool, default=False
   :param \*\*kwargs: Additional key-word arguments to pass to download()
   :type \*\*kwargs: dict


.. py:function:: download_cli(**kwargs)

   Downloads the extra ISOFIT plotting utilities from the repository https://github.com/isofit/isofit-plots.
   This will install the package into your current environment along with its dependencies.

   
   Run `isofit download paths` to see default path locations.
   There are two ways to specify output directory:
       - `isofit --plots /path/plots download plots`: Override the ini file. This will save the provided path for future reference.
       - `isofit download plots --path /path/plots`: Temporarily set the output location. This will not be saved in the ini and may need to be manually set.
   It is recommended to use the first style so the download path is remembered in the future.


.. py:function:: validate_cli(**kwargs)

   Validates the installation of the ISOFIT extra data files as well as checks for updates