Libradtran
source module isofit.data.cli.libradtran
Downloads LibRadTran from https://www.libradtran.org/download/libRadtran-2.0.6.tar.gz
Functions
-
build — Builds a LibRadTran directory
-
download — Downloads LibRadTran from https://www.libradtran.org/download/libRadtran-2.0.6.tar.gz.
-
validate — Validates a LibRadTran installation
-
update — Checks for an update and executes a new download if it is needed Note: Not implemented for this module at this time
-
download_cli — Downloads LibRadTran from https://www.libradtran.org/download/libRadtran-2.0.6.tar.gz. Only HDF5 versions are supported at this time.
-
validate_cli — Validates the installation of LibRadTran
Builds a LibRadTran directory
Parameters
-
directory : str — Directory with an unbuilt LibRadTran
Notes
If on MacOS, executing the make command may fail if the user hasn't agreed to the
Xcode and Apple SDKs license yet. In these cases, it may be required to run the
following command in order to compile the program:
$ sudo xcodebuild -license
source download(path=None, overwrite=False, **_)
Downloads LibRadTran from https://www.libradtran.org/download/libRadtran-2.0.6.tar.gz.
Parameters
-
output : str | None — Path to output as. If None, defaults to the ini path.
-
overwrite : bool, default=False — Overwrite an existing installation
-
**_ : dict — Ignores unused params that may be used by other validate functions. This is to maintain compatibility with other functions
source validate(path=None, debug=print, error=print, **_)
Validates a LibRadTran installation
Parameters
-
path : str, default=None — Path to verify. If None, defaults to the ini path
-
debug : function, default=print — Print function to use for debug messages, eg. logging.debug
-
error : function, default=print — Print function to use for error messages, eg. logging.error
-
**_ : dict — Ignores unused params that may be used by other validate functions. This is to maintain compatibility with env.validate
Returns
-
bool — True if valid, False otherwise
source 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
Parameters
-
check : bool, default=False — Just check if an update is available, do not download
-
**kwargs : dict — Additional key-word arguments to pass to download()
source download_cli(**kwargs)
Downloads LibRadTran from https://www.libradtran.org/download/libRadtran-2.0.6.tar.gz. Only HDF5 versions are supported at this time.
Run isofit download paths to see default path locations.
There are two ways to specify output directory:
- isofit --path libradtran /path/libradtran download libradtran: Override the ini file. This will save the provided path for future reference.
- isofit download libradtran --path /path/libradtran: 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.
source validate_cli(**kwargs)
Validates the installation of LibRadTran