icenet package

Subpackages

• icenet.data package
  • Subpackages
    • icenet.data.interfaces package
      • Submodules
      • icenet.data.interfaces.cds module
      • icenet.data.interfaces.downloader module
      • icenet.data.interfaces.esgf module
      • icenet.data.interfaces.mars module
      • icenet.data.interfaces.utils module
      • Module contents
    • icenet.data.processors package
      • Submodules
      • icenet.data.processors.cmip module
      • icenet.data.processors.era5 module
      • icenet.data.processors.hres module
      • icenet.data.processors.meta module
      • icenet.data.processors.osi module
      • icenet.data.processors.utils module
      • Module contents
    • icenet.data.sic package
      • Submodules
      • icenet.data.sic.mask module
      • icenet.data.sic.osisaf module
      • Module contents
  • Submodules
  • icenet.data.cli module
    • add_date_args()
    • csv_arg()
    • csv_of_csv_arg()
    • date_arg()
    • dates_arg()
    • download_args()
    • int_or_list_arg()
    • process_args()
    • process_date_args()
  • icenet.data.dataset module
    • IceNetDataSet
      • IceNetDataSet._config
      • IceNetDataSet._configuration_path
      • IceNetDataSet._batch_size
      • IceNetDataSet._counts
      • IceNetDataSet._dtype
      • IceNetDataSet._loader_config
      • IceNetDataSet._generate_workers
      • IceNetDataSet._n_forecast_days
      • IceNetDataSet._num_channels
      • IceNetDataSet._shape
      • IceNetDataSet._shuffling
      • IceNetDataSet.channels
      • IceNetDataSet.counts
      • IceNetDataSet.get_data_loader()
      • IceNetDataSet.loader_config
    • MergedIceNetDataSet
      • MergedIceNetDataSet.channels
      • MergedIceNetDataSet.check_dataset()
      • MergedIceNetDataSet.counts
      • MergedIceNetDataSet.get_data_loader()
    • check_dataset()
    • get_args()
  • icenet.data.loader module
    • create()
    • create_get_args()
    • save_sample()
  • icenet.data.process module
    • IceNetPreProcessor
      • IceNetPreProcessor.DATE_FORMAT
      • IceNetPreProcessor.mean_and_std()
      • IceNetPreProcessor.missing_dates
      • IceNetPreProcessor.post_normalisation()
      • IceNetPreProcessor.pre_normalisation()
      • IceNetPreProcessor.process()
      • IceNetPreProcessor.update_loader_config()
  • icenet.data.producers module
    • DataCollection
      • DataCollection._identifier
      • DataCollection._path
      • DataCollection._hemisphere
      • DataCollection.base_path
      • DataCollection.identifier
    • DataProducer
      • DataProducer.dry
      • DataProducer.overwrite
      • DataProducer.get_data_var_folder()
    • Downloader
      • Downloader.download()
    • Generator
      • Generator.generate()
    • Processor
      • Processor._file_filters
      • Processor._lead_time
      • Processor.source_data
      • Processor._var_files
      • Processor._processed_files
      • Processor._dates
      • Processor.dates
      • Processor.init_source_data()
      • Processor.lead_time
      • Processor.process()
      • Processor.processed_files
      • Processor.save_processed_file()
      • Processor.source_data
  • icenet.data.utils module
    • assign_lat_lon_coord_system()
    • esgf_search()
    • gridcell_angles_from_dim_coords()
    • invert_gridcell_angles()
    • rotate_grid_vectors()
  • Module contents
• icenet.model package
  • Submodules
  • icenet.model.callbacks module
    • BatchwiseModelCheckpoint
      • BatchwiseModelCheckpoint.on_train_batch_end()
    • IceNetPreTrainingEvaluator
      • IceNetPreTrainingEvaluator.on_train_batch_end()
  • icenet.model.losses module
    • WeightedMSE
  • icenet.model.metrics module
    • ConstructLeadtimeAccuracy
      • ConstructLeadtimeAccuracy.from_config()
      • ConstructLeadtimeAccuracy.get_config()
      • ConstructLeadtimeAccuracy.result()
      • ConstructLeadtimeAccuracy.update_state()
    • WeightedBinaryAccuracy
      • WeightedBinaryAccuracy.get_config()
      • WeightedBinaryAccuracy.result()
      • WeightedBinaryAccuracy.update_state()
    • WeightedMAE
      • WeightedMAE.result()
      • WeightedMAE.update_state()
    • WeightedMSE
      • WeightedMSE.result()
      • WeightedMSE.update_state()
    • WeightedRMSE
      • WeightedRMSE.result()
      • WeightedRMSE.update_state()
  • icenet.model.models module
    • TemperatureScale
      • TemperatureScale.call()
      • TemperatureScale.get_config()
    • linear_trend_forecast()
    • unet_batchnorm()
  • icenet.model.predict module
    • date_arg()
    • get_args()
    • main()
    • predict_forecast()
    • run_prediction()
  • icenet.model.train module
    • evaluate_model()
    • get_args()
    • main()
    • train_model()
  • icenet.model.utils module
    • arr_to_ice_edge_arr()
    • arr_to_ice_edge_rgba_arr()
    • compute_heatmap()
    • make_exp_decay_lr_schedule()
  • Module contents
• icenet.plotting package
  • Submodules
  • icenet.plotting.utils module
    • broadcast_forecast()
    • calculate_extents()
    • filter_ds_by_obs()
    • geographic_box()
    • get_bounds()
    • get_crs()
    • get_custom_cmap()
    • get_forecast_ds()
    • get_geoextent_polygon()
    • get_obs_da()
    • get_plot_axes()
    • get_seas_forecast_da()
    • get_seas_forecast_init_dates()
    • pixel_to_projection()
    • process_block()
    • process_probes()
    • process_region()
    • projection_to_geographic_coords()
    • reproject_array()
    • reproject_projected_coords()
    • set_ffmpeg_path()
    • set_plot_geoaxes()
    • set_plot_geoextent()
    • show_img()
  • icenet.plotting.video module
    • cli_args()
    • data_cli()
    • get_dataarray_from_files()
    • recurse_data_folders()
    • video_process()
    • xarray_to_video()
  • Module contents
• icenet.process package
  • Submodules
  • icenet.process.azure module
    • upload()
    • upload_parse_args()
  • icenet.process.forecasts module
    • broadcast_args()
    • broadcast_main()
    • create_geotiff_output()
    • geotiff_args()
    • reproject_args()
    • reproject_main()
    • reproject_output()
  • icenet.process.local module
    • upload()
    • upload_parse_args()
  • icenet.process.predict module
    • create_cf_output()
    • date_arg()
    • get_args()
    • get_prediction_data()
    • get_refcube()
    • get_refsic()
  • icenet.process.train module
  • icenet.process.utils module
    • date_arg()
    • destination_filename()
  • Module contents
• icenet.results package
  • Module contents
• icenet.tests package
  • Submodules
  • icenet.tests.test_mod module
  • Module contents

Submodules

icenet.exceptions module

exception icenet.exceptions.CredentialsNotFoundError

Bases: Exception

Covers scenarios where a credential file has not been found

icenet.utils module

class icenet.utils.Hemisphere(value)

Bases: Flag

Representation of hemispheres & both with bitwise operations.

An enum.Flag derived class representing the different hemispheres

(north, south, or both), providing methods to check which hemisphere is selected via bitwise operations:

& (AND), | (OR), ^ (XOR), and ~ (INVERT)

BOTH = 3

NONE = 0

NORTH = 1

SOUTH = 2

class icenet.utils.HemisphereMixin

Bases: object

A mixin relating to Hemisphere checking.

_hemisphere

Represents the bitmask value of the hemisphere. Defaults to Hemisphere.NONE (i.e., 0).

Type:

int

property both: int

The bitmask value representing both hemispheres.

property hemisphere: int

The bitmask value representing the hemisphere.

property hemisphere_loc: list

Get a list of latitude and longitude extent representing the hemisphere’s location.

property hemisphere_str: list

A list of strings representing the selected hemispheres.

property north: bool

A flag indicating if _hemisphere is north. True if the hemisphere is north, False otherwise.

property south: bool

A flag indicating if _hemisphere is south. True if the hemisphere is south, False otherwise.

class icenet.utils.LogFormat(str_format: str = '[%(asctime)-17s :%(levelname)-8s] - %(message)s', date_format: str = '%d-%m-%y %T')

Bases: object

Creates a logging formatter for use across IceNet.

date_format: str = '%d-%m-%y %T'

formatter: Formatter

str_format: str = '[%(asctime)-17s :%(levelname)-8s] - %(message)s'

icenet.utils.check_pytorch_import(logger: Logger) → bool

Check for availability of pytorch module

Parameters:

logger – A Logger instance

Returns:

Whether torch was successfully imported

Return type:

pytorch_available

Example

>>> logger = setup_module_logging(__name__)
>>> pytorch_available = check_pytorch_import(logger)

icenet.utils.run_command(command: str, dry: bool = False) → object

Run a shell command

A wrapper in case we want some additional handling to go in here

Parameters:

• command – Command to run in shell.

• dry (optional) – Whether to do a dry run or to run actual command. Default is False.

Returns:

subprocess.CompletedProcess return of the executed command.

icenet.utils.setup_logging(func, log_format='[%(asctime)-17s :%(levelname)-8s] - %(message)s')

icenet.utils.setup_module_logging(module_name: str, level: int = None)

Configure logger based on input name

Parameters:

• module_name – Name for the logger

• level – Logging level, can be int, or constants from logging module (e.g. logging.INFO)

Returns:

A configured Logger instance

Module contents

Top-level package for IceNet.