isofit.data.cli.imagecube
=========================

.. py:module:: isofit.data.cli.imagecube

.. autoapi-nested-parse::

   Downloads the extra ISOFIT image cube data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/



Attributes
----------

.. autoapisummary::

   isofit.data.cli.imagecube.CMD
   isofit.data.cli.imagecube.URL
   isofit.data.cli.imagecube.size


Functions
---------

.. autoapisummary::

   isofit.data.cli.imagecube.download
   isofit.data.cli.imagecube.validate
   isofit.data.cli.imagecube.update
   isofit.data.cli.imagecube.download_cli
   isofit.data.cli.imagecube.validate_cli


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

.. py:data:: CMD
   :value: 'imagecube'


.. py:data:: URL
   :value: 'https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/{size}_chunk.zip'


.. py:function:: download(path=None, size='both', overwrite=False, **_)

   Downloads the extra ISOFIT data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/.

   :param path: Path to output as. If None, defaults to the ini path.
   :type path: str | None
   :param size: Which chunk size to pull
   :type size: "both" | "small" | "medium"
   :param overwrite: Overwrite an existing installation
   :type overwrite: bool, default=False
   :param \*\*_: Ignores unused params that may be used by other validate functions. This is to
                 maintain compatibility with other functions
   :type \*\*_: dict


.. py:function:: validate(path=None, size='both', debug=print, error=print, **_)

   Validates an ISOFIT image cube data installation

   :param path: Path to verify. If None, defaults to the ini path
   :type path: str, default=None
   :param size: Which chunk size to validate
   :type size: "both" | "small" | "medium"
   :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

   .. 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
   Note: Not implemented for this module at this time

   :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:data:: size

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

   Downloads the extra ISOFIT image cube data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/.

   
   Run `isofit download paths` to see default path locations.
   There are two ways to specify output directory:
       - `isofit --imagecube /path/imagecube download imagecube`: Override the ini file. This will save the provided path for future reference.
       - `isofit download imagecube --path /path/imagecube`: 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 image cube data