apcac.indexes#

{Short module description (1-3 sentences)} todo docstring

Features#

todo docstring

  • {feature 1}

  • {feature 2}

  • {feature 3}

  • {etc}

Overview#

todo docstring {Overview description}

Examples#

todo docstring {Examples in rST}

Print a message

# print message
print("Hello world!")
# [Output] >> 'Hello world!'

Functions

compute_index_c(input_ppt, input_pet, ...)

compute_index_e(input_slope, input_k, ...)

compute_index_g(input_q, output_folder)

compute_index_n(input_ppt, input_pet, ...)

compute_index_s(input_sandp, input_socp, ...)

compute_index_t(input_hand, input_twi, ...)

compute_index_v(input_n0, input_n1, t0, t1, ...)

fuzzify(input_file, output_file, low, hi)

get_timestamp()

make_run_folder(run_name, folder_outputs)

process_data(input1, input2, output_folder)

Demo for processing data

waiter()

apcac.indexes.compute_index_e(input_slope, input_k, output_folder)[source]#
apcac.indexes.compute_index_v(input_n0, input_n1, t0, t1, output_folder)[source]#
apcac.indexes.compute_index_n(input_ppt, input_pet, output_folder)[source]#
apcac.indexes.compute_index_c(input_ppt, input_pet, output_folder)[source]#
apcac.indexes.compute_index_g(input_q, output_folder)[source]#
apcac.indexes.compute_index_s(input_sandp, input_socp, output_folder)[source]#
apcac.indexes.compute_index_t(input_hand, input_twi, output_folder, hand_w=0.5, hand_max=15, twi_max=15)[source]#
apcac.indexes.process_data(input1, input2, output_folder)[source]#

Demo for processing data

Parameters:

  • input1 (str) – file path to input data 1

  • input2 (str) – file path to input data 1

  • output_folder (str) – file path to output folder

apcac.indexes.fuzzify(input_file, output_file, low, hi)[source]#
apcac.indexes.waiter()[source]#
apcac.indexes.get_timestamp()[source]#
apcac.indexes.make_run_folder(run_name, folder_outputs)[source]#