speasy.core package

speasy.core.deprecation(message: str) → None

Shows a deprecation warning.

Parameters:

message: str

Custom message to show

speasy.core.mkdir(directory: str) → None

Creates directory and parents if they do not exist

Parameters:

directory: str

Path to create

speasy.core.progress_bar(leave=True, progress=False, desc=None, **kwargs)

Subpackages

• speasy.core.cache package
  • add_item()
  • cache_disk_size()
  • cache_len()
  • drop_item()
  • drop_matching_entries()
  • entries()
  • get_item()
  • stats()
  • Submodules
    • speasy.core.cache.cache module
      • Cache
      • CacheItem
    • speasy.core.cache.version module
      • str_to_version()
      • version_to_str()
• speasy.core.cdf package
  • Submodules
    • speasy.core.cdf.inventory_extractor module
      • extract_parameter()
      • extract_parameters()
      • filter_dataset_meta()
      • filter_variable_meta()
      • make_dataset_index()
• speasy.core.codecs package
  • CodecInterface
    • CodecInterface.load_variable()
    • CodecInterface.load_variables()
    • CodecInterface.name
    • CodecInterface.save_variables()
    • CodecInterface.supported_extensions
    • CodecInterface.supported_mimetypes
  • get_codec()
  • register_codec()
  • user_codecs_dir()
  • Subpackages
    • speasy.core.codecs.bundled_codecs package
      • Subpackages
      • Submodules
  • Submodules
    • speasy.core.codecs.codec_interface module
      • CodecInterface
    • speasy.core.codecs.codecs_registry module
      • get_codec()
      • load_extra_codecs()
      • register_codec()
      • user_codecs_dir()
• speasy.core.direct_archive_downloader package
  • Submodules
    • speasy.core.direct_archive_downloader.direct_archive_downloader module
      • RandomSplitDirectDownload
      • RegularSplitDirectDownload
      • apply_date_format()
      • filter_ranges()
      • get_product()
      • map_ranges()
      • spilt_range()
• speasy.core.impex package
  • ImpexProductType
    • ImpexProductType.CATALOG
    • ImpexProductType.COMPONENT
    • ImpexProductType.DATASET
    • ImpexProductType.PARAMETER
    • ImpexProductType.TIMETABLE
    • ImpexProductType.UNKNOWN
  • ImpexProvider
    • ImpexProvider.build_inventory()
    • ImpexProvider.build_private_inventory()
    • ImpexProvider.credential_are_valid()
    • ImpexProvider.dataset_range()
    • ImpexProvider.find_parent_dataset()
    • ImpexProvider.get_catalog()
    • ImpexProvider.get_data()
    • ImpexProvider.get_dataset()
    • ImpexProvider.get_parameter()
    • ImpexProvider.get_timetable()
    • ImpexProvider.get_user_catalog()
    • ImpexProvider.get_user_parameter()
    • ImpexProvider.get_user_timetable()
    • ImpexProvider.is_user_catalog()
    • ImpexProvider.is_user_parameter()
    • ImpexProvider.is_user_product()
    • ImpexProvider.is_user_timetable()
    • ImpexProvider.list_catalogs()
    • ImpexProvider.list_datasets()
    • ImpexProvider.list_parameters()
    • ImpexProvider.list_timetables()
    • ImpexProvider.list_user_catalogs()
    • ImpexProvider.list_user_parameters()
    • ImpexProvider.list_user_timetables()
    • ImpexProvider.parameter_range()
    • ImpexProvider.product_type()
    • ImpexProvider.reset_credentials()
    • ImpexProvider.to_index()
  • Submodules
    • speasy.core.impex.client module
      • ImpexClient
      • ImpexEndpoint
    • speasy.core.impex.exceptions module
      • BadTemplateArgDefinition
      • MissingCredentials
      • UnavailableEndpoint
    • speasy.core.impex.parser module
      • ImpexXMLParser
      • to_xmlid()
    • speasy.core.impex.utils module
      • is_private()
      • is_public()
      • load_catalog()
      • load_timetable()
• speasy.core.index package
  • Submodules
    • speasy.core.index.speasy_index module
      • SpeasyIndex
• speasy.core.inventory package
  • FlatInventories
  • ProviderInventory
    • ProviderInventory.catalogs
    • ProviderInventory.clear()
    • ProviderInventory.components
    • ProviderInventory.datasets
    • ProviderInventory.missions
    • ProviderInventory.parameters
    • ProviderInventory.timetables
    • ProviderInventory.update()
  • Submodules
    • speasy.core.inventory.indexes module
      • ArgumentIndex
      • ArgumentListIndex
      • CatalogIndex
      • ComponentIndex
      • DatasetIndex
      • ParameterIndex
      • SpeasyIndex
      • TemplatedParameterIndex
      • TimetableIndex
      • from_dict()
      • from_json()
      • inventory_has_changed()
      • make_inventory_node()
      • to_dict()
      • to_json()
• speasy.core.proxy package
  • GetInventory
    • GetInventory.get()
  • GetProduct
    • GetProduct.get()
  • ProxyError
  • Proxyfiable
  • decompress()
  • is_proxy_up()
  • query_proxy_version()
• speasy.core.requests_scheduling package
  • Submodules
    • speasy.core.requests_scheduling.request_dispatch module
      • get_data()
      • init_amda()
      • init_archive()
      • init_cdaweb()
      • init_cdpp3dview()
      • init_csa()
      • init_providers()
      • init_sscweb()
      • init_uiowaephtool()
      • list_providers()
      • provider_and_product()
    • speasy.core.requests_scheduling.split_large_requests module
      • SplitLargeRequests

Submodules

• speasy.core.algorithms module
  • AllowedKwargs
  • fix_name()
  • pack_kwargs()
  • randomized_map()
• speasy.core.any_files module
  • AnyFile
    • AnyFile.close()
    • AnyFile.ok
    • AnyFile.read()
    • AnyFile.readline()
    • AnyFile.seek()
    • AnyFile.status_code
    • AnyFile.url
  • any_loc_open()
  • list_files()
• speasy.core.data_containers module
  • DataContainer
    • DataContainer.astype()
    • DataContainer.copy()
    • DataContainer.dtype
    • DataContainer.empty_like()
    • DataContainer.from_dictionary()
    • DataContainer.is_time_dependent
    • DataContainer.meta
    • DataContainer.name
    • DataContainer.nbytes
    • DataContainer.ndim
    • DataContainer.ones_like()
    • DataContainer.reserve_like()
    • DataContainer.reshape()
    • DataContainer.select()
    • DataContainer.shape
    • DataContainer.to_dictionary()
    • DataContainer.unit
    • DataContainer.unit_applied()
    • DataContainer.values
    • DataContainer.view()
    • DataContainer.zeros_like()
  • DataContainerProtocol
    • DataContainerProtocol.astype()
    • DataContainerProtocol.dtype
    • DataContainerProtocol.from_dictionary()
    • DataContainerProtocol.is_time_dependent
    • DataContainerProtocol.name
    • DataContainerProtocol.nbytes
    • DataContainerProtocol.reserve_like()
    • DataContainerProtocol.select()
    • DataContainerProtocol.shape
    • DataContainerProtocol.to_dictionary()
    • DataContainerProtocol.unit
    • DataContainerProtocol.values
    • DataContainerProtocol.view()
  • VariableAxis
    • VariableAxis.astype()
    • VariableAxis.data_container
    • VariableAxis.dtype
    • VariableAxis.empty_like()
    • VariableAxis.from_dictionary()
    • VariableAxis.is_time_dependent
    • VariableAxis.meta
    • VariableAxis.name
    • VariableAxis.nbytes
    • VariableAxis.ones_like()
    • VariableAxis.reserve_like()
    • VariableAxis.select()
    • VariableAxis.shape
    • VariableAxis.to_dictionary()
    • VariableAxis.unit
    • VariableAxis.values
    • VariableAxis.view()
    • VariableAxis.zeros_like()
  • VariableTimeAxis
    • VariableTimeAxis.astype()
    • VariableTimeAxis.data_container
    • VariableTimeAxis.dtype
    • VariableTimeAxis.empty_like()
    • VariableTimeAxis.from_dictionary()
    • VariableTimeAxis.is_time_dependent
    • VariableTimeAxis.meta
    • VariableTimeAxis.name
    • VariableTimeAxis.nbytes
    • VariableTimeAxis.ones_like()
    • VariableTimeAxis.reserve_like()
    • VariableTimeAxis.select()
    • VariableTimeAxis.shape
    • VariableTimeAxis.to_dictionary()
    • VariableTimeAxis.unit
    • VariableTimeAxis.values
    • VariableTimeAxis.view()
    • VariableTimeAxis.zeros_like()
  • np_build_result_name()
  • numpy_supported()
• speasy.core.dataprovider module
  • DataProvider
    • DataProvider.build_inventory()
    • DataProvider.build_private_inventory()
    • DataProvider.update_inventory()
  • ParameterRangeCheck
• speasy.core.datetime_range module
  • DateTimeRange
    • DateTimeRange.duration
    • DateTimeRange.intersect()
    • DateTimeRange.split()
    • DateTimeRange.start_time
    • DateTimeRange.stop_time
• speasy.core.http module
  • Response
    • Response.bytes
    • Response.headers
    • Response.json()
    • Response.ok
    • Response.status_code
    • Response.text
    • Response.url
  • auth_header()
  • is_server_up()
  • urlopen()
• speasy.core.platform module
  • is_running_on_wasm()
• speasy.core.span_utils module
  • contains()
  • difference()
  • equals()
  • intersection()
  • intersects()
  • is_empty()
  • is_span()
  • merge()
  • shift()
  • span_ctor()
  • split()
  • zoom()
• speasy.core.time module
  • EnsureUTCDateTime
  • datetime64_to_epoch()
  • epoch_to_datetime64()
  • make_utc_datetime()
  • make_utc_datetime64()
• speasy.core.typing module
  • all_of_type()
  • is_collection()
  • listify()
• speasy.core.url_utils module
  • ApplyRewriteRules
  • apply_rewrite_rules()
  • build_url()
  • ensure_url_scheme()
  • extract_path()
  • host_and_port()
  • is_local_file()
  • quote()