idmtools_platform_comps.utils.lookups module

idmtools comps lookups.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

idmtools_platform_comps.utils.lookups.get_experiment_by_id(exp_id, query_criteria: COMPS.Data.QueryCriteria.QueryCriteria = None) → COMPS.Data.Experiment.Experiment

Get an experiment by id.

idmtools_platform_comps.utils.lookups.get_simulation_by_id(sim_id, query_criteria: COMPS.Data.QueryCriteria.QueryCriteria = None) → COMPS.Data.Simulation.Simulation

Fetches simulation by id and optional query criteria.

Wrapped in additional Retry Logic. Used by other lookup methods

Parameters:

• sim_id –

• query_criteria – Optional QueryCriteria to search with

Returns:

Simulation with ID

idmtools_platform_comps.utils.lookups.get_all_experiments_for_user(user: str) → List[COMPS.Data.Experiment.Experiment]

Returns all the experiments for a specific user.

Parameters:

user – username to locate

Returns:

Experiments for a user

idmtools_platform_comps.utils.lookups.get_simulations_from_big_experiments(experiment_id)

Get simulation for large experiment. This allows us to pull simulations in chunks.

Parameters:

experiment_id – Experiment id to load

Returns:

List of simulations