Package index

API Connections

use_OpenMpp_local() use_OpenMpp_remote()

OpenM++ API Connections

Class Accessors

load_model()

OpenM++ Model Class

load_workset() load_scenario()

OpenM++ Workset Class

load_model_run() load_run()

OpenM++ ModelRun Class

load_model_runs() load_runs()

OpenM++ ModelRunSet Class

All Functions

admin_models_refresh() admin_models_close() admin_database_close() admin_model_delete() admin_database_open() admin_database_cleanup() admin_cleanup_logs() admin_cleanup_log() admin_jobs_pause() admin_jobs_pause_all() admin_service_shutdown()

OpenM++ Administrative Tasks

create_scenario()

Manage Model Scenarios

create_task() update_task() delete_task()

Update Modeling Tasks

delete_model_run() delete_run() delete_model_runs() delete_runs()

Update Model Runs

get_model() get_models() get_models_list()

Model Metadata

get_model_lang_list() get_model_word_list() get_model_profile() get_model_profile_list()

Model Extras

get_model_run() get_run() get_model_runs_list() get_model_runs() get_runs() get_model_run_status() get_run_status() get_model_run_list_status() get_model_run_status_first() get_model_run_status_last() get_model_run_status_compl()

Model Run Results Metadata

get_model_task() get_model_tasks_list() get_model_tasks() get_model_task_worksets() get_model_task_hist() get_model_task_status() get_model_task_run_list_status() get_model_task_run_first() get_model_task_run_last() get_model_task_run_compl()

Modeling Task Metadata

get_run_microdata() get_run_microdata_csv()

Read Run Microdata

get_run_table() get_run_table_csv() get_run_table_calc_csv() get_run_table_comparison_csv()

Read Output Tables

get_service_config() get_service_state() get_disk_use() refresh_disk_use() get_active_job_state() get_queue_job_state() get_hist_job_state() set_queue_job_pos() delete_job_hist()

OpenM++ Model Run Jobs and Service State

get_user_files() upload_user_files() create_user_files_folder() delete_user_files() delete_user_files_all()

Manage OpenM++ User Files

get_user_views() set_user_views() delete_user_views()

Manage OpenM++ User Settings

get_workset() get_worksets_list() get_worksets() get_scenarios() get_workset_status() get_workset_status_default()

Model Workset Metadata

get_workset_param() get_workset_param_csv() get_run_param() get_run_param_csv()

Read Parameters

initiate_model_download() initiate_run_download() initiate_workset_download() delete_download_files() delete_download_files_async() get_download_log() get_download_logs_model() get_download_logs_all() get_download_filetree()

Download Model, Model Run Results, or Input Parameters

initiate_run_upload() initiate_workset_upload() delete_upload_files() delete_upload_files_async() get_upload_log() get_upload_logs_model() get_upload_logs_all() get_upload_filetree()

Upload Model Runs or Worksets

is_compatible()

Are data frames compatible?

load_model()

OpenM++ Model Class

load_model_run() load_run()

OpenM++ ModelRun Class

load_model_runs() load_runs()

OpenM++ ModelRunSet Class

load_workset() load_scenario()

OpenM++ Workset Class

opts_run() print(<OpenMppRunOpts>)

Run Configuration Options

run_model() get_model_run_state() get_run_state() stop_model_run() stop_run()

Run Models and Monitor Progress

set_workset_readonly() create_workset() merge_workset() update_workset_param_csv() replace_workset() delete_workset() delete_scenario() delete_workset_param() update_workset_param() copy_param_run_to_workset() merge_param_run_to_workset() copy_param_workset_to_workset() merge_param_workset_to_workset() upload_workset_params()

Update Workset Metadata

touch_model_profile() delete_model_profile() set_model_profile_opt() delete_model_profile_opt()

Update Model Profile

use_OpenMpp_local() use_OpenMpp_remote()

OpenM++ API Connections