Backend module for capice-compute-backend.

Classes:

ISSMJob(job_name, file_transfer_method, ...)

Functions:

download_file(url, filename)	Download file from URL.
version_info()	Get the version of extpar and extpar_client.

class capice_compute.api.ISSMJob(job_name: str, file_transfer_method: str, slurm_settings: SlurmSettings, swift_settings: SwiftSettings = SwiftSettings(os_auth_token='', os_storage_url='', swift_url='https://swift.dkrz.de', swift_container='issm'), nextcloud_settings: NextcloudSettings = NextcloudSettings(nextcloud_auth_token='', nextcloud_user='', nextcloud_url='https://nextcloud.awi.de', nextcloud_container='issm'), module_settings: List[str] = ['load slurm_setup', 'load user_spack'], spack_settings: List[str] = ['load python/6rg45wj'])

Bases: object

Methods:

bamg(hmax, hmin, gradation, field, err)	Run ISSM function bamg on the backend.
create_empty_model()	Creation of an empty model file on the backend.
download_model_file(url)
get_mesh(prop)	Get information about the mesh from ISSM model.
interp_from_grid_to_mesh(input_file, ...[, ...])	Call function InterpFromGridToMesh from ISSM.
paterson(temperature)	Call function paterson from ISSM.
run(solution_step[, mail_to])	Run ISSM solve.
set_basalforcings(setting, value)	Set basal forcing settings for ISSM model.
set_friction(setting, value)	Set friction settings for ISSM model.
set_geometry(setting, value)	Set geometry settings for ISSM model.
set_initialization(setting, value)	Set initialization settings for ISSM model.
set_inversion(setting, value)	Set inversion settings for ISSM model.
set_mask(setting, value)	Set mask settings for ISSM model.
set_masstransport(setting, value)	Set masstransport settings for ISSM model.
set_materials(setting, value)	Set materials settings for ISSM model.
set_mesh(setting, value)	Set mesh settings for ISSM model.
set_miscellaneous(setting, value)	Set miscellaneous settings for ISSM model.
set_smb(setting, value)	Set SMB settings for ISSM model.
set_stressbalance(setting, value)	Set stressbalance settings for ISSM model.
set_thermal(setting, value)	Set thermal settings for ISSM model.
set_timestepping(setting, value)	Set timestepping settings for ISSM model.
setflowequation(flowmodel, option)	Run ISSM function setflowequation.
setmask(floatingicename, groundedicename)	Run ISSM function setmask on backend.
triangle(domain_file, resolution)	Run ISSM function triangle on the backend.
upload_model_file(upload)
xy2ll(sign_lat, central_meridian, ...)	Run ISSM function xy2ll on backend.

bamg(hmax: float, hmin: float, gradation: float, field: List[float], err: float) → Tuple[int, int]

Run ISSM function bamg on the backend.

create_empty_model() → None

Creation of an empty model file on the backend.

download_model_file(url: str) → str

get_mesh(prop: str) → Any

Get information about the mesh from ISSM model.

interp_from_grid_to_mesh(input_file: str, x_variable: str, y_variable: str, interp_variable: str, default_value: float, scale_factor: float = 1.0) → List[float]

Call function InterpFromGridToMesh from ISSM.

paterson(temperature: List[float]) → List[float]

Call function paterson from ISSM.

run(solution_step: str, mail_to: List[str] = ['']) → str

Run ISSM solve.

set_basalforcings(setting: str, value: Any) → None

Set basal forcing settings for ISSM model.

set_friction(setting: str, value: Any) → None

Set friction settings for ISSM model.

set_geometry(setting: str, value: Any) → None

Set geometry settings for ISSM model.

set_initialization(setting: str, value: Any) → None

Set initialization settings for ISSM model.

set_inversion(setting: str, value: Any) → None

Set inversion settings for ISSM model.

set_mask(setting: str, value: Any) → None

Set mask settings for ISSM model.

set_masstransport(setting: str, value: Any) → None

Set masstransport settings for ISSM model.

set_materials(setting: str, value: Any) → None

Set materials settings for ISSM model.

set_mesh(setting: str, value: Any) → None

Set mesh settings for ISSM model.

set_miscellaneous(setting: str, value: Any) → None

Set miscellaneous settings for ISSM model.

set_smb(setting: str, value: Any) → None

Set SMB settings for ISSM model.

set_stressbalance(setting: str, value: Any) → None

Set stressbalance settings for ISSM model.

set_thermal(setting: str, value: Any) → None

Set thermal settings for ISSM model.

set_timestepping(setting: str, value: Any) → None

Set timestepping settings for ISSM model.

setflowequation(flowmodel: str, option: str) → None

Run ISSM function setflowequation.

setmask(floatingicename: str, groundedicename: str) → None

Run ISSM function setmask on backend.

triangle(domain_file: str, resolution: float) → Tuple[int, int]

Run ISSM function triangle on the backend.

upload_model_file(upload: str) → str

xy2ll(sign_lat: int, central_meridian: int, standard_parallel: int) → None

Run ISSM function xy2ll on backend.

capice_compute.api.download_file(url: str, filename: str) → str

Download file from URL.

capice_compute.api.version_info() → Dict[str, str]

Get the version of extpar and extpar_client.