numerous.client package#

Subpackages#

Submodules#

Module contents#

class numerous.client.DataSourcesReader(client, scenario_data, start_time, t0, te, dt, tag_prefix, tag_separator, timeout)#

Bases: object

read(t)#
set_retry_delay(value)#
set_retry_timeout(value)#
exception numerous.client.DataStreamTimeoutBreakStatus(break_status)#

Bases: Exception

class numerous.client.NumerousAdminClient(server=None, port=None, secure=None, refresh_token=None, url=None)#

Bases: object

add_execution_schedule(execution_id, sleep_after, sleep_for, enable_scheduling)#
add_job_schedule(project_id, scenario_id, job_id, organization_id, user_id, sleep_after, sleep_for, enable_scheduling)#
check_health()#
clear_execution(scenario, execution)#
close()#
complete_signup(invitationID, firstName, lastName, organization)#
delete_execution(exe_id)#
delete_system(system)#
delete_user(user)#
enqueue_build(repository, commit_id, launch_after_build=False, tags=None)#
generate_scenario_token(project, scenario, job, user_id, organization_id, agent, purpose, admin=False)#
get_build_info(repository, build_id)#
get_execution_schedule(execution_id)#
get_execution_status(exe_id)#
get_job_schedule(project_id, scenario_id, job_id, organization_id, user_id)#
hibernate_job(project_id, scenario_id, job_id, organization_id, user_id)#
launch_job(project, scenario, job)#
Return type:

str

login_get_refresh(email, password)#
push_scenario_logs_admin(logs, exe_id)#
read_execution_logs(execution_id, project_id)#
remove_data_execution(scenario, execution)#
remove_execution(scenario, execution)#
remove_execution_schedule(execution_id)#
remove_job_schedule(project_id, scenario_id, job_id, organization_id, user_id)#
reset_job(project, scenario, job)#
resume_job(project_id, scenario_id, job_id, organization_id, user_id)#
terminate_job(project, scenario, job)#
update_build(repository, build_id, **update)#
update_execution(update_)#
update_execution_schedule(execution_id, sleep_after, sleep_for, enable_scheduling)#
update_job_by_backend(project, scenario, job, exe, message, status, log=None, complete=False)#
update_job_schedule(project_id, scenario_id, job_id, organization_id, user_id, sleep_after, sleep_for, enable_scheduling)#
update_scenario_image(name, path, project, scenario, job, repository, commit, build, internal=True)#
class numerous.client.NumerousClient(job_id=None, project=None, scenario=None, server=None, port=None, refresh_token=None, clear_data=None, no_log=False, instance_id=None, secure=None, url=None, log_level=40, execution_id=None, trace=False)#

Bases: object

class DataStreamStats(min, max, len)#

Bases: object

len: Optional[int]#
max: Optional[float]#
min: Optional[float]#
clear_scenario_results(scenario=None)#
clear_timeseries_data(scenario=None, execution=None)#
close()#
complete_execution()#
data_read_df(tags=None, start=None, end=None, project=None, scenario=None, execution=None)#
data_read_raw(tags=None, start=None, end=None, project=None, scenario=None, execution=None, index_by_time=True)#
data_write_df(df, scenario=None, execution=None, clear=True)#
download_file_path(remote_path, local_path, overwrite=False)#
Return type:

None

download_file_paths(path_mapping, overwrite=False)#
Return type:

None

get_data_sources_reader(t0, te, scenario_data=None, dt=3600.0, tag_prefix='Stub', tag_separator='.', timeout=10.0, start_time=None)#
Return type:

DataSourcesReader

get_data_stream_stats(scenario=None, execution=None, tags=None)#
Return type:

Dict[str, DataStreamStats]

get_data_stream_status(scenario, execution)#
get_dataset_closed(project=None, scenario=None, execution=None)#
get_download_files(files, local_path='./tmp', scenario=None, project_id=None)#
get_execution_state(execution_id)#
get_group_document(group)#
get_inputs(scenario_data, t0=0, te=0, dt=3600, tag_prefix='Stub', tag_separator='.', timeout=10)#
get_job(scenario_doc=None)#
get_latest_main_execution(project=None, scenario=None)#
get_model(model_id, project_id=None, scenario_id=None)#
get_project_document()#
get_scenario(scenario=None, project=None, path='.')#
get_scenario_document(scenario=None, project=None)#
Return type:

Tuple[Dict[str, Any], Iterable[FileSignedUrl]]

get_scenario_results(scenario=None)#
get_scenario_results_document(scenario=None, execution=None)#
get_state(scenario=None, execution=None)#
get_timeseries_custom_meta_data(scenario=None, project_id=None, execution=None, key=None)#
get_timeseries_meta_data(project=None, scenario=None, execution=None)#
get_timeseries_stats(project=None, scenario=None, execution=None, tag=None)#
hibernate(message='Hibernating')#

Call this function to hibernate Client. This will enable client to reload its state after being restarted at a later point.

Return type:

None

listen_scenario_document(scenario=None, project=None)#
new_writer(buffer_size=100, clear=False, queue_max_size=100)#
noop()#
open_data_stream(tags=None, start=None, end=None, project=None, scenario=None, execution=None, latest_execution=False, subscribe=False, index_by_time=True)#
open_read_data_stream(scenario=None, execution=None)#
open_write_data_stream(scenario=None, execution=None)#
open_writer(aliases=None, clear=False, buffer_size=168)#
Return type:

Generator[NumerousBufferedWriter, None, None]

property optimization_config: OptimizationConfiguration#
property params: JobParameters#
publish_message(message, channel=None)#
push_scenario_error(error, scenario=None)#
push_scenario_logs(logs)#
read_data(tags=None, start=None, end=None, project=None, scenario=None, execution=None, latest_execution=False, subscribe=False, index_by_time=True)#
read_data_as_row(tags=None, start=None, end=None, scenario=None, execution=None, project=None, subscribe=False, offset=0, index_by_time=True)#
read_data_stream(tags=None, start=None, end=None, scenario=None, execution=None, project=None, index_by_time=True)#
refresh_token(refresh_token)#
property run_settings: RunSettings#
set_data_stream_status(scenario, execution, status)#
set_hibernation_callback(func, *args, **kwargs)#

Use this function to set a callback to be used when job is hibernated. :type _sphinx_paramlinks_numerous.client.NumerousClient.set_hibernation_callback.func: :param _sphinx_paramlinks_numerous.client.NumerousClient.set_hibernation_callback.func: function to be called

Return type:

None

set_optimization_iteration_score(iteration_scenario_id, score)#
set_optimization_result(optimal_scenario_id, score, settings)#
set_scenario_progress(message, status, progress=None, clean=False, scenario=None, force=False, project=None, job=None)#
set_scenario_results(names, values, units, scenario=None)#
set_scenario_results_document(results_dict, scenario=None, execution=None)#
set_state(state, scenario=None, execution=None, force=False)#
set_timeseries_custom_meta_data(meta, scenario=None, project_id=None, execution=None, key=None)#
set_timeseries_meta_data(tags, aliases=None, offset=0, timezone='UTC', epoch_type='s', scenario=None, execution=None, project=None)#
start_iteration_scenario(target_scenario_id, target_job_id, override_settings)#
property state: ScenarioState#
subscribe_messages(channel_patterns)#
upload_file(local_file, file_id, file=None, scenario=None, content_type='text/html')#
upload_file_path(remote_path, local_path)#
was_resumed()#

Returns True if job was resumed and False otherwise

Return type:

bool

write_with_row_generator(data_generator, scenario=None, clear=False, must_flush=None, execution=None, last_item_index=0)#
Return type:

None

property writer: NumerousBufferedWriter#
writer_closed(scenario)#
class numerous.client.ScenarioStatus(value)#

Bases: str, Enum

An enumeration.

ENVIRONMENT_INITIALIZING = 'Environment Initializing'#
EQUATIONS_ASSEMBLY = 'Equations Assembly'#
FAILED = 'failed'#
FINISHED = 'finished'#
HIBERNATING = 'hibernating'#
INITIALZING = 'initializing'#
MODEL_INITIALIZING = 'Model Initializing'#
REQUESTED = 'requested'#
RUNNING = 'running'#
WAITING = 'Waiting'#
numerous.client.open_admin_client(server=None, port=None, secure=None, refresh_token=None)#
Return type:

Generator[NumerousAdminClient, None, None]

numerous.client.open_client(job_id=None, project=None, scenario=None, clear_data=None, no_log=False, instance_id=None, refresh_token=None, trace=False)#
Return type:

Generator[NumerousClient, None, None]