IHEWAcollect.templates package

Subpackages

Submodules

IHEWAcollect.templates.collect module

IHEWAcollect.templates.download_tiles_test module

IHEWAcollect.templates.dtime module

Dtime

Examples:

from IHEWAcollect.templates.dtime import Dtime

dtime = Dtime(workspace=path, is_print=True)
class IHEWAcollect.templates.dtime.Dtime(_Dtime__status, _Dtime__conf, **kwargs)[source]

Bases: object

conf = {'data': {}, 'dtime': {'i': 0, 'r': []}, 'file': {'i': '', 'o': ''}, 'path': '', 'time': {'e': datetime.datetime(2023, 4, 5, 12, 37, 42, 660757), 's': datetime.datetime(2023, 4, 5, 12, 37, 42, 660750)}}
get_time_range(dtime_s, dtime_e, arg_resolution)[source]
set_status(fun='', prt=False, ext='')[source]

Set status

Parameters:

  • fun (str) – Function name.

  • prt (bool) – Is to print on screen?

  • ext (str) – Extra message.

status = 'Global status.'

IHEWAcollect.templates.gis module

IHEWAcollect.templates.util module

utils

Utilities for IHEWAcollect template modules.

Examples:

from IHEWAcollect.templates.util import Extract, Plot, Waitbar, Log
class IHEWAcollect.templates.util.Extract(file, folder, is_print)[source]

Bases: object

Extract class

File pre-process, extract.

Parameters:

  • file (str) – File.

  • folder (str) – Folder.

  • is_print (bool) – Is to print status message.

gz()[source]

Extract gz file

This function extract gz file.

Parameters:

  • file (str) – Name of the file that must be unzipped.

  • outfile (str) – Directory where the unzipped data must be stored.

tar()[source]

Extract tar file

This function extract tar file.

Parameters:

  • file (str) – Name of the file that must be unzipped.

  • outfile (str) – Directory where the unzipped data must be stored.

zip()[source]

Extract zip file

This function extract zip file.

Parameters:

  • file (str) – Name of the file that must be unzipped.

  • outfile (str) – Directory where the unzipped data must be stored.

class IHEWAcollect.templates.util.Log(config, **kwargs)[source]

Bases: object

Log class

Write message to log file.

Parameters:

config (dict) – Is to print status message.

data = {}
write(time, msg='')[source]
class IHEWAcollect.templates.util.Plot(data, file, folder, is_print, is_save, is_show)[source]

Bases: object

Plot class

File post-process, save or show.

Parameters:

  • data –

  • file –

  • folder –

  • is_print (bool) – Is to print status message.

  • is_save (bool) – Is to save files in the folder.

  • is_show (bool) – Is to show files in the folder.

class IHEWAcollect.templates.util.Waitbar(is_print)[source]

Bases: object

Waitbar class

Waitbar on the cmd window.

Parameters:

is_print (bool) – Is to print status message.

static wait_bar(i, total, prefix='', suffix='', decimals=1, length=100, fill='█')[source]

Wait Bar Console

This function will print a waitbar in the console

Parameters:

  • i (int) – Iteration number.

  • total (int) – Total iterations.

  • prefix (str) – Prefix name of bar.

  • suffix (str) – Suffix name of bar.

  • decimals (int) – Decimal of the wait bar.

  • length (int) – Width of the wait bar.

  • fill (str) – Bar fill.

Module contents

IHEWAcollect template modules