<sphinx.addnodesdocument)}( rawsourcechildren](docutils.nodescomment)}(htwinmodules documentation master file, created by sphinx-quickstart on Tue May 30 08:36:01 2023. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.h]h Texttwinmodules documentation master file, created by sphinx-quickstart on Tue May 30 08:36:01 2023. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.}parenth sba attributes}(ids]classes]names]dupnames]backrefs] xml:spacepreserveutagnameh hh _documenthsourceKC:\Users\rpivovar\Desktop\workingfolder\projects\twinmodules\docs\index.rstlineKubh section)}(hhh](h title)}(h'Welcome to twinmodules's documentation!h]h)Welcome to twinmodules’s documentation!}(hh1h&hh'Nh)Nubah}(h]h]h]h]h!]uh%h/hh,h&hh'h(h)Kubh compound)}(hhh]htoctree)}(hhh]h}(h]h]h]h]h!]hindexentries] includefiles]maxdepthKcaption Contents:globhidden includehiddennumberedK titlesonly rawentries] rawcaptionhVuh%hDh'h(h)K hhAubah}(h]h]toctree-wrapperah]h]h!]uh%h?hh,h&hh'h(h)Nubeh}(h]&welcome-to-twinmodules-s-documentationah]h]'welcome to twinmodules's documentation!ah]h!]uh%h*hhh&hh'h(h)Kubh+)}(hhh](h0)}(hIndices and tablesh]hIndices and tables}(hhqh&hh'Nh)Nubah}(h]h]h]h]h!]uh%h/hhnh&hh'h(h)Kubh paragraph)}(hBrowse the API:h]hBrowse the API:}(hhh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)Khhnh&hubh bullet_list)}(hhh]h list_item)}(h:ref:`modindex` h]h)}(h:ref:`modindex`h]h pending_xref)}(hhh]h inline)}(hhh]hmodindex}(hhh&hh'Nh)Nubah}(h]h](xrefstdstd-refeh]h]h!]uh%hhhubah}(h]h]h]h]h!]refdochO refdomainhreftyperef refexplicitrefwarn reftargetmodindexuh%hh'h(h)Khhubah}(h]h]h]h]h!]uh%hh'h(h)Khhubah}(h]h]h]h]h!]uh%hhhh&hh'h(h)Nubah}(h]h]h]h]h!]bullet*uh%hh'h(h)Khhnh&hubh)}(h!Or search for something specific:h]h!Or search for something specific:}(hhh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)Khhnh&hubh)}(hhh]h)}(h:ref:`search` h]h)}(h :ref:`search`h]h)}(hhh]h)}(hhh]hsearch}(hhh&hh'Nh)Nubah}(h]h](hstdstd-refeh]h]h!]uh%hhhubah}(h]h]h]h]h!]refdochO refdomainhreftyperef refexplicitrefwarnhsearchuh%hh'h(h)Khhubah}(h]h]h]h]h!]uh%hh'h(h)Khhubah}(h]h]h]h]h!]uh%hhhh&hh'h(h)Nubah}(h]h]h]h]h!]hhuh%hh'h(h)Khhnh&hubeh}(h]indices-and-tablesah]h]indices and tablesah]h!]uh%h*hhh&hh'h(h)Kubh+)}(hhh](h0)}(h TwinModulesh]h TwinModules}(hj,h&hh'Nh)Nubah}(h]h]h]h]h!]uh%h/hj)h&hh'h(h)Kubh)}(hThe goal of TwinModules is to provide a python API that reduces the time spent coding routine functions needed to interact with the AWS cloud or local data sources. TwinModules currently does not intend to provide Infrastructure as Code (IaC) automation.h]hThe goal of TwinModules is to provide a python API that reduces the time spent coding routine functions needed to interact with the AWS cloud or local data sources. TwinModules currently does not intend to provide Infrastructure as Code (IaC) automation.}(hj:h&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K hj)h&hubh)}(hSupported functionality includes, but is not limited to: - Building docker images and pushing to AWS ECR - Tools for push and pulling data from:h]hSupported functionality includes, but is not limited to: - Building docker images and pushing to AWS ECR - Tools for push and pulling data from:}(hjHh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K"hj)h&hubh block_quote)}(hH- AWS S3 Buckets - AWS IoT SiteWise - AWS SQS - AWS Timestream - AWS RDSh]h)}(hhh](h)}(hAWS S3 Bucketsh]h)}(hjah]hAWS S3 Buckets}(hjch&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K%hj_ubah}(h]h]h]h]h!]uh%hhj\ubh)}(hAWS IoT SiteWiseh]h)}(hjxh]hAWS IoT SiteWise}(hjzh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K&hjvubah}(h]h]h]h]h!]uh%hhj\ubh)}(hAWS SQSh]h)}(hjh]hAWS SQS}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K'hjubah}(h]h]h]h]h!]uh%hhj\ubh)}(hAWS Timestreamh]h)}(hjh]hAWS Timestream}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K(hjubah}(h]h]h]h]h!]uh%hhj\ubh)}(hAWS RDSh]h)}(hjh]hAWS RDS}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K)hjubah}(h]h]h]h]h!]uh%hhj\ubeh}(h]h]h]h]h!]hՌ-uh%hh'h(h)K%hjXubah}(h]h]h]h]h!]uh%jVh'h(h)K%hj)h&hubh)}(hhh](h)}(h5Tools for HPC style job execution utilizing AWS Batchh]h)}(hjh]h5Tools for HPC style job execution utilizing AWS Batch}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K*hjubah}(h]h]h]h]h!]uh%hhjh&hh'h(h)Nubh)}(hX<Automation (Intended to be used in conjunction with TwinStat): - Autoscaling virtual sensors - detect when virtual sensors need to be created or destroyed - Timeseries signal statistical steady-state detection - Set up of SQL backends for: - uncertainty propagation - sensitivity studies - global optimization h](h)}(h\Automation (Intended to be used in conjunction with TwinStat): - Autoscaling virtual sensorsh]h\Automation (Intended to be used in conjunction with TwinStat): - Autoscaling virtual sensors}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K+hjubjW)}(h=- detect when virtual sensors need to be created or destroyedh]h)}(hhh]h)}(h;detect when virtual sensors need to be created or destroyedh]h)}(hjh]h;detect when virtual sensors need to be created or destroyed}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K-hjubah}(h]h]h]h]h!]uh%hhjubah}(h]h]h]h]h!]hjuh%hh'h(h)K-hj ubah}(h]h]h]h]h!]uh%jVh'h(h)K-hjubh)}(hhh](h)}(h4Timeseries signal statistical steady-state detectionh]h)}(hj:h]h4Timeseries signal statistical steady-state detection}(hj<h&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K.hj8ubah}(h]h]h]h]h!]uh%hhj5ubh)}(hSet up of SQL backends for:h]h)}(hjQh]hSet up of SQL backends for:}(hjSh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K/hjOubah}(h]h]h]h]h!]uh%hhj5ubeh}(h]h]h]h]h!]hjuh%hh'h(h)K.hjubjW)}(hG- uncertainty propagation - sensitivity studies - global optimization h]h)}(hhh](h)}(huncertainty propagationh]h)}(hjuh]huncertainty propagation}(hjwh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K0hjsubah}(h]h]h]h]h!]uh%hhjpubh)}(hsensitivity studiesh]h)}(hjh]hsensitivity studies}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K1hjubah}(h]h]h]h]h!]uh%hhjpubh)}(hglobal optimization h]h)}(hglobal optimizationh]hglobal optimization}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K2hjubah}(h]h]h]h]h!]uh%hhjpubeh}(h]h]h]h]h!]hjuh%hh'h(h)K0hjlubah}(h]h]h]h]h!]uh%jVh'h(h)K0hjubeh}(h]h]h]h]h!]uh%hhjh&hh'h(h)Nubeh}(h]h]h]h]h!]hjuh%hh'h(h)K*hj)h&hubeh}(h] twinmodulesah]h] twinmodulesah]h!]uh%h*hhh&hh'h(h)Kubh+)}(hhh](h0)}(h Requirements:h]h Requirements:}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%h/hjh&hh'h(h)K6ubh)}(hhh](h)}(h+Supported Operating Systems: Linux, Windowsh]h)}(hjh]h+Supported Operating Systems: Linux, Windows}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K8hjubah}(h]h]h]h]h!]uh%hhjh&hh'h(h)Nubh)}(h Python 3.10+ h]h)}(h Python 3.10+h]h Python 3.10+}(hjh&hh'Nh)Nubah}(h]h]h]h]h!]uh%hh'h(h)K9hjubah}(h]h]h]h]h!]uh%hhjh&hh'h(h)Nubeh}(h]h]h]h]h!]hjuh%hh'h(h)K8hjh&hubeh}(h] requirementsah]h] requirements:ah]h!]uh%h*hhh&hh'h(h)K6ubh+)}(hhh](h0)}(h Installationh]h Installation}(hj-h&hh'Nh)Nubah}(h]h]h]h]h!]uh%h/hj*h&hh'h(h)Khj*h&hubh literal_block)}(hpgit clone git@ssh.gitlab.aws.dev:autonomouscomputesateam/twinmodules.git cd twinmodules/dist pip install ./*.whlh]hpgit clone git@ssh.gitlab.aws.dev:autonomouscomputesateam/twinmodules.git cd twinmodules/dist pip install ./*.whl}hjKsbah}(h]h]h]h]h!]h#h$forcelanguagepythonhighlight_args}uh%jIh'h(h)K@hj*h&hubeh}(h] installationah]h] installationah]h!]uh%h*hhh&hh'h(h)K