"""
Downloads the extra ISOFIT data files from the repository https://github.com/isofit/isofit-data
"""
from pathlib import Path
from isofit.data import env, shared
from isofit.data.download import download_file, prepare_output, release_metadata, unzip
[docs]
def download(path=None, tag="latest", overwrite=False, **_):
"""
Downloads the extra ISOFIT data files from the repository https://github.com/isofit/isofit-data.
Parameters
----------
path : str | None
Path to output as. If None, defaults to the ini path
tag : str
Release tag to pull from the github
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
"""
print(f"Downloading ISOFIT data")
output = prepare_output(path, env.data, overwrite=overwrite)
if not output:
return
metadata = release_metadata("isofit", "isofit-data", tag)
print(f"Pulling release {metadata['tag_name']}")
zipfile = download_file(metadata["zipball_url"], output.parent / "isofit-data.zip")
print(f"Unzipping {zipfile}")
avail = unzip(zipfile, path=output.parent, rename=output.name, overwrite=overwrite)
with open(output / "version.txt", "w") as file:
file.write(metadata["tag_name"])
print(f"Done, now available at: {avail}")
[docs]
def validate(path=None, checkForUpdate=True, debug=print, error=print, **_):
"""
Validates an ISOFIT data installation
Parameters
----------
path : str, default=None
Path to verify. If None, defaults to the ini path
checkForUpdate : bool, default=True
Checks for updates if the path is valid
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
"""
if path is None:
path = env.data
debug(f"Verifying path for ISOFIT data: {path}")
if not (path := Path(path)).exists():
error("[x] Data path does not exist")
return False
# Just validate some key files
check = [
"earth_sun_distance.txt",
"emit_model_discrepancy.mat",
"testrfl.dat",
]
files = list(path.glob("*"))
if not all([path / file in files for file in check]):
error("[x] ISOFIT data do not appear to be installed correctly")
return False
debug("[OK] Path is valid")
if checkForUpdate:
return isUpToDate(path, debug=debug, error=error)
return True
[docs]
def isUpToDate(path=None, tag="latest", debug=print, error=print, **_):
"""
Checks the installed version against the latest release
Parameters
----------
path : str, default=None
Path to update. 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 other functions
Returns
-------
bool
True if the path is up to date, False otherwise
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.
"""
if path is None:
path = env.data
debug(f"Checking for updates for data on path: {path}")
file = Path(path) / "version.txt"
if not file.exists():
error(
"[x] Failed to find a version.txt file under the given path. Version is unknown"
)
return False
metadata = release_metadata("isofit", "isofit-data", tag)
with open(file, "r") as f:
current = f.read()
if current != (latest := metadata["tag_name"]):
error(f"[x] Latest is {latest}, currently installed is {current}")
return False
debug(f"[OK] Path is up to date, current version is: {current}")
return True
[docs]
def update(check=False, **kwargs):
"""
Checks for an update and executes a new download if it is needed
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()
"""
debug = kwargs.get("debug", print)
if not validate(**kwargs):
if not check:
kwargs["overwrite"] = True
debug("Executing update")
download(**kwargs)
else:
debug(f"Please download the latest via `isofit download {CMD}`")
@shared.download.command(name=CMD)
@shared.path(help="Root directory to download data files to, ie. [path]/data")
@shared.tag
@shared.overwrite
@shared.check
[docs]
def download_cli(**kwargs):
"""\
Downloads the extra ISOFIT data files from the repository https://github.com/isofit/isofit-data.
\b
Run `isofit download paths` to see default path locations.
There are two ways to specify output directory:
- `isofit --data /path/data download data`: Override the ini file. This will save the provided path for future reference.
- `isofit download data --path /path/data`: 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.
"""
if kwargs.get("overwrite"):
download(**kwargs)
else:
update(**kwargs)
@shared.validate.command(name=CMD)
@shared.path(help="Root directory to download data files to, ie. [path]/data")
@shared.tag
[docs]
def validate_cli(**kwargs):
"""\
Validates the installation of the ISOFIT extra data files as well as checks for updates
"""
validate(**kwargs)