icenet package¶
Subpackages¶
- icenet.data package
- Subpackages
- Submodules
- icenet.data.cli module
- 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
check_dataset()
get_args()
- icenet.data.loader module
- icenet.data.process module
- icenet.data.producers module
- icenet.data.utils module
- Module contents
- icenet.model package
- icenet.plotting package
- icenet.process package
- icenet.results package
- icenet.tests package
Submodules¶
icenet.utils module¶
- class icenet.utils.Hemisphere(value)[source]¶
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[source]¶
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.
- icenet.utils.run_command(command: str, dry: bool = False) object [source]¶
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.
Module contents¶
Top-level package for IceNet.