8Qsphinx.addnodesdocument)}( rawsourcechildren]docutils.nodessection)}(hhh](h title)}(hcomponents moduleh]h Textcomponents module}(parenth _documenthsourceNlineNuba attributes}(ids]classes]names]dupnames]backrefs]utagnamehhh hhhUC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\docs\core\components.rsthKubhindex)}(hhh]h}(h!]h#]h%]h']h)]entries](pairmodule; componentsmodule-componentshNtauh+h-hh hhhNhNubh.)}(hhh]h}(h!]h#]h%]h']h)]entries](single*autoscale_sensors() (in module components)components.autoscale_sensorshNtauh+h-hh hhhNhNubhdesc)}(hhh](hdesc_signature)}(hautoscale_sensors(iam_role, s3_bucket_name, ansys_license_server='', virtual_sensor_img='', cpu=2, memory=2048, gpu=0, s3_IoT_key='DG-NG-sensor-data/')h](h desc_addname)}(h components.h]h components.}(hhZhhhNhNubah}(h!]h#]( sig-prename descclassnameeh%]h']h)] xml:spacepreserveuh+hXhhThhhC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\core\components.py:docstring of components.autoscale_sensorshKubh desc_name)}(hautoscale_sensorsh]hautoscale_sensors}(hhohhhNhNubah}(h!]h#](sig-namedescnameeh%]h']h)]hjhkuh+hmhhThhhhlhKubhdesc_parameterlist)}(hiam_role, s3_bucket_name, ansys_license_server='', virtual_sensor_img='', cpu=2, memory=2048, gpu=0, s3_IoT_key='DG-NG-sensor-data/'h](hdesc_parameter)}(hiam_roleh]h desc_sig_name)}(hiam_roleh]hiam_role}(hhhhhNhNubah}(h!]h#]nah%]h']h)]uh+hhhubah}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hs3_bucket_nameh]h)}(hs3_bucket_nameh]hs3_bucket_name}(hhhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubah}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hansys_license_server=''h](h)}(hansys_license_serverh]hansys_license_server}(hhhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubhdesc_sig_operator)}(h=h]h=}(hhhhhNhNubah}(h!]h#]oah%]h']h)]uh+hhhubh inline)}(h''h]h''}(hhhhhNhNubah}(h!]h#] default_valueah%]h']h)]support_smartquotesuh+hhhubeh}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hvirtual_sensor_img=''h](h)}(hvirtual_sensor_imgh]hvirtual_sensor_img}(hhhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhhubh)}(h''h]h''}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhhubeh}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hcpu=2h](h)}(hcpuh]hcpu}(hj.hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj*ubh)}(h=h]h=}(hj<hhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj*ubh)}(h2h]h2}(hjJhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhj*ubeh}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(h memory=2048h](h)}(hmemoryh]hmemory}(hjchhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj_ubh)}(h=h]h=}(hjqhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhj_ubh)}(h2048h]h2048}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhj_ubeh}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hgpu=0h](h)}(hgpuh]hgpu}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h0h]h0}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhhubh)}(hs3_IoT_key='DG-NG-sensor-data/'h](h)}(h s3_IoT_keyh]h s3_IoT_key}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h=h]h=}(hjhhhNhNubah}(h!]h#]hah%]h']h)]uh+hhjubh)}(h'DG-NG-sensor-data/'h]h'DG-NG-sensor-data/'}(hjhhhNhNubah}(h!]h#]hah%]h']h)]support_smartquotesuh+hhjubeh}(h!]h#]h%]h']h)]hjhkuh+hhhubeh}(h!]h#]h%]h']h)]hjhkuh+hhhThhhhlhKubeh}(h!]hKah#](sig sig-objecteh%]h']h)]module componentsclasshfullnamehq _toc_partsj hq _toc_nameautoscale_sensors()uh+hRhhlhKhhOhhubh desc_content)}(hhh](h paragraph)}(hAutomatically create or destroy virtual sensors in an AWS Batch environment. This function can be used with or without an ANSYS license server. :rtype: :py:obj:`None`h](hAutomatically create or destroy virtual sensors in an AWS Batch environment. This function can be used with or without an ANSYS license server. :rtype: }(hjhhhNhNubh pending_xref)}(h:py:obj:`None`h]h literal)}(hj'h]hNone}(hj+hhhNhNubah}(h!]h#](xrefpypy-objeh%]h']h)]uh+j)hj%ubah}(h!]h#]h%]h']h)]refdoccore/components refdomainj6reftypeobj refexplicitrefwarn py:modulej py:classN reftargetNoneuh+j#hC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\twinmodules\core\components.py:docstring of components.autoscale_sensorshKhjubeh}(h!]h#]h%]h']h)]uh+jhjLhKhjhhubh enumerated_list)}(hhh](h list_item)}(h=A connection to the Batch compute environment is established.h]j)}(hj\h]h=A connection to the Batch compute environment is established.}(hj^hhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhKhjZubah}(h!]h#]h%]h']h)]uh+jXhjUhhhjLhNubjY)}(h:The general job definition for a virtual sensor is definedh]j)}(hjsh]h:The general job definition for a virtual sensor is defined}(hjuhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhKhjqubah}(h!]h#]h%]h']h)]uh+jXhjUhhhjLhNubjY)}(hGExisting running virtual sensors (i.e. existing Batch jobs) are queriedh]j)}(hjh]hGExisting running virtual sensors (i.e. existing Batch jobs) are queried}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhKhjubah}(h!]h#]h%]h']h)]uh+jXhjUhhhjLhNubjY)}(hX|New sensor is checked in an S3 Bucket Objects are assumed to be named: _#. All of the object # are determined and assumed that a virtual sensor will be associated with each #. If there is no virtual sensor from step 3 associated with #, then a virtual sensor will be created. If there is a virtual sensor and no associated #, then the sensor will be destroyed. h](j)}(h%New sensor is checked in an S3 Bucketh]h%New sensor is checked in an S3 Bucket}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhK hjubj)}(hXTObjects are assumed to be named: _#. All of the object # are determined and assumed that a virtual sensor will be associated with each #. If there is no virtual sensor from step 3 associated with #, then a virtual sensor will be created. If there is a virtual sensor and no associated #, then the sensor will be destroyed.h]hXTObjects are assumed to be named: _#. All of the object # are determined and assumed that a virtual sensor will be associated with each #. If there is no virtual sensor from step 3 associated with #, then a virtual sensor will be created. If there is a virtual sensor and no associated #, then the sensor will be destroyed.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhK hjubeh}(h!]h#]h%]h']h)]uh+jXhjUhhhjLhNubjY)}(h0Kill all sensors no longer associated with data.h]j)}(hjh]h0Kill all sensors no longer associated with data.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhKhjubah}(h!]h#]h%]h']h)]uh+jXhjUhhhjLhNubjY)}(hFCreate all new sensors that do not exist, but data is now available. h]j)}(hDCreate all new sensors that do not exist, but data is now available.h]hDCreate all new sensors that do not exist, but data is now available.}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jhjLhKhjubah}(h!]h#]h%]h']h)]uh+jXhjUhhhjLhNubeh}(h!]h#]h%]h']h)]enumtypearabicprefixhsuffix)uh+jShjhhhjLhKubh field_list)}(hhh](h field)}(hhh](h field_name)}(h Parametersh]h Parameters}(hj hhhNhNubah}(h!]h#]h%]h']h)]uh+j hjhhlhKubh field_body)}(hhh]h bullet_list)}(hhh](jY)}(hhh]j)}(h;iam_role (str) -- IAM rol to be assumed by virtual sensors.h](hliteral_strong)}(hiam_roleh]hiam_role}(hj,hhhNhNubah}(h!]h#]h%]h']h)]uh+j*hj&ubh (}(hj&hhhNhNubj$)}(hhh]hliteral_emphasis)}(hstrh]hstr}(hjChhhNhNubah}(h!]h#]h%]h']h)]uh+jAhj>ubah}(h!]h#]h%]h']h)] refdomainpy refexplicitreftypej reftargetjE refspecificjHj jINuh+j#hj&ubh)}(hj&hhhNhNubh – }(hj&hhhNhNubh)IAM rol to be assumed by virtual sensors.}(hj&hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj#ubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(hs3_bucket_name (str) -- The s3 bucket to look for data. #TODO: will add connections to all other TwinModules data sources. For meta data determination.h](j+)}(hs3_bucket_nameh]hs3_bucket_name}(hj|hhhNhNubah}(h!]h#]h%]h']h)]uh+j*hjxubh (}(hjxhhhNhNubj$)}(hhh]jB)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjxubh)}(hjxhhhNhNubh – }(hjxhhhNhNubhThe s3 bucket to look for data. #TODO: will add connections to all other TwinModules data sources. For meta data determination.}(hjxhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjuubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(hlansys_license_server (str, optional) -- Use this license server ip address if applicable. The default is "".h](j+)}(hansys_license_serverh]hansys_license_server}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j*hjubh (}(hjhhhNhNubj$)}(hhh]jB)}(hstrh]hstr}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjubjB)}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubj$)}(hhh]jB)}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjubh)}(hjhhhNhNubh – }(hjhhhNhNubhHUse this license server ip address if applicable. The default is “”.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(hZvirtual_sensor_img (str, optional) -- The container image to use (URL). The default is "".h](j+)}(hvirtual_sensor_imgh]hvirtual_sensor_img}(hj=hhhNhNubah}(h!]h#]h%]h']h)]uh+j*hj9ubh (}(hj9hhhNhNubj$)}(hhh]jB)}(hstrh]hstr}(hjRhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjOubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjTj\jHj jINuh+j#hj9ubjB)}(h, h]h, }(hjjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhj9ubj$)}(hhh]jB)}(hoptionalh]hoptional}(hj{hhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjxubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetj}j\jHj jINuh+j#hj9ubh)}(hj9hhhNhNubh – }(hj9hhhNhNubh8The container image to use (URL). The default is “”.}(hj9hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj6ubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(hQcpu (int, optional) -- Required cpus needed for virtual sensor. The default is 2.h](j+)}(hcpuh]hcpu}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j*hjubh (}(hjhhhNhNubj$)}(hhh]jB)}(hinth]hint}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjubjB)}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubj$)}(hhh]jB)}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjubh)}(hjhhhNhNubh – }(hjhhhNhNubh:Required cpus needed for virtual sensor. The default is 2.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(h\memory (int, optional) -- Required RAM in MB needed for virtual sensor. The default is 2048.h](j+)}(hmemoryh]hmemory}(hj'hhhNhNubah}(h!]h#]h%]h']h)]uh+j*hj#ubh (}(hj#hhhNhNubj$)}(hhh]jB)}(hinth]hint}(hj<hhhNhNubah}(h!]h#]h%]h']h)]uh+jAhj9ubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetj>j\jHj jINuh+j#hj#ubjB)}(h, h]h, }(hjThhhNhNubah}(h!]h#]h%]h']h)]uh+jAhj#ubj$)}(hhh]jB)}(hoptionalh]hoptional}(hjehhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjbubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjgj\jHj jINuh+j#hj#ubh)}(hj#hhhNhNubh – }(hj#hhhNhNubhBRequired RAM in MB needed for virtual sensor. The default is 2048.}(hj#hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(hgpu (int, optional) -- Number of gpus needed by virtual sensor. Note the AWS Batch compute environment must be able to support gpus. The default is 0.h](j+)}(hgpuh]hgpu}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j*hjubh (}(hjhhhNhNubj$)}(hhh]jB)}(hinth]hint}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjubjB)}(h, h]h, }(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubj$)}(hhh]jB)}(hoptionalh]hoptional}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjj\jHj jINuh+j#hjubh)}(hjhhhNhNubh – }(hjhhhNhNubhNumber of gpus needed by virtual sensor. Note the AWS Batch compute environment must be able to support gpus. The default is 0.}(hjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jXhj ubjY)}(hhh]j)}(his3_IoT_key (str, optional) -- The s3 key/folder to use for new data. The default is "DG-NG-sensor-data/".h](j+)}(h s3_IoT_keyh]h s3_IoT_key}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j*hj ubh (}(hj hhhNhNubj$)}(hhh]jB)}(hstrh]hstr}(hj&hhhNhNubah}(h!]h#]h%]h']h)]uh+jAhj#ubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetj(j\jHj jINuh+j#hj ubjB)}(h, h]h, }(hj>hhhNhNubah}(h!]h#]h%]h']h)]uh+jAhj ubj$)}(hhh]jB)}(hoptionalh]hoptional}(hjOhhhNhNubah}(h!]h#]h%]h']h)]uh+jAhjLubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetjQj\jHj jINuh+j#hj ubh)}(hj hhhNhNubh – }(hj hhhNhNubhOThe s3 key/folder to use for new data. The default is “DG-NG-sensor-data/”.}(hj hhhNhNubeh}(h!]h#]h%]h']h)]uh+jhj ubah}(h!]h#]h%]h']h)]uh+jXhj ubeh}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubj)}(hhh](j )}(h Return typeh]h Return type}(hjhhhNhNubah}(h!]h#]h%]h']h)]uh+j hjhhlhKubj)}(hhh]j)}(hNoneh]j$)}(hhh]hNone}(hjhhhNhNubah}(h!]h#]h%]h']h)] refdomainjX refexplicitreftypej reftargetNonej\jHj jINuh+j#hjubah}(h!]h#]h%]h']h)]uh+jhjubah}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjubeh}(h!]h#]h%]h']h)]uh+jhjhhhNhNubeh}(h!]h#]h%]h']h)]uh+jhhOhhhhlhKubeh}(h!]h#](jXfunctioneh%]h']h)]domainjXobjtypejdesctypejnoindex noindexentrynocontentsentryuh+hMhhhh hNhNubeh}(h!](h<components-moduleeh#]h%]components moduleah']h)]uh+h hhhhhh,hKubah}(h!]h#]h%]h']h)]sourceh,uh+hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh, _destinationN _config_files]file_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}jjs nametypes}jsh!}(jh h