Skip to content

Latest commit

 

History

History
128 lines (98 loc) · 3.36 KB

dtkt-convert.rst

File metadata and controls

128 lines (98 loc) · 3.36 KB
Raw

Convert scripts from

Understanding some of the similarities and differences between and will help when converting scripts from to use within .

Configuration .ini files have different names, simtools.ini in and idmtools.ini in . Simtools.ini is required while idmtools.ini is optional.

Platform configuration, HPC or local, in is set using the SetupParser class while in the :py~idmtools.core.platform_factory.Platform class is used.

Simulation configuration, such as intervention parameters and reports, in are set using the DTKConfigBuilder class while in it's configured through a base task object.

Configuration .ini files

Please see the following diagram which helps illustrate some of the differences between the required simtools.ini used in with the optional idmtools.ini used in .

hide circle

class simtools{

[DEFAULT] max_threads = 1 sims_per_threads = 1 max_local_sims = 6 server_endpoint = https://comps.idmod.org environment = Belegost

[HPC] type = HPC

}

note top of simtools DTK-Tools end note

class idmtools{

[COMPS] priority = Lowest num_retries = 0 endpoint = https://comps.idmod.org environment = Belegost type = COMPS

[COMMON] max_threads = 1 sims_per_thread = 1 max_local_sims = 6 max_workers = 1 batch_size = 10

}

note top of idmtools idmtools end note

idmtools -left[hidden]-> simtools

Platform configuration

In addition to using INI files for platform configuration parameters you can also use Python class objects, SetupParser in and :py~idmtools.core.platform_factory.Platform in . If platform configuration parameters are configured in an INI file and also configured in a Python class object then the parameters in the Python object take priority.

DTK-Tools:

SetupParser.default_block = 'HPC'

idmtools:

platform = Platform("Belegost")

When using :py~idmtools.core.platform_factory.Platform you can specify a predefined configuration alias, such as Belegost, when using the platform. To see a list of aliases, use the cli command idmtools info plugins platform-aliases.

Simulation configuration

DTKConfigBuilder in is used for setting the intervention parameters and reports for simulations run with while uses task objects. For example, when using the :py~emodpy.emod_task.EMODTask class is used.

hide circle

class DTKConfigBuilder{

config campaign demographics report

}

note top of DTKConfigBuilder DTK-Tools end note

class EMODTask{

task.config task.campaign task.demographics task.reporter

}

note top of EMODTask idmtools/emodpy end note

EMODTask -left[hidden]-> DTKConfigBuilder

Example

To see an applied example of the previously described information you can see a converted csv analyzer to and additional information on converting analyzers here: analyzers/analyzers-convert.