.. _index:

SIMO package structure
######################

System building modules (XML document to Python object conversion):

Data import, simulation, optimization and reporting descriptions are constructed with the builder package. It's responsible for parsing the xml documents, validating them and constructing the class instances of them, and storing both the xml documents, xml schema documents and Python class instances in a ZODB object database.

Each xml schema has a corresponding builder module and Python class responsible for parsing and validating the xml documents conforming the the schema document:

.. toctree::
   :maxdepth: 1

   builder.xmlobject<builder/test/xmlobject-py>
   builder.importers.operation2modelchains<builder/importers/test/operation2modelchains-py>
   builder.importers.text2data<builder/importers/test/text2data-py>
   builder.importers.text2operation<builder/importers/test/text2operation-py>
   builder.lexicon.lexicon<builder/lexicon/test/lexicon-py>
   builder.lexicon.lexiconlevel<builder/lexicon/test/lexiconlevel-py>
   builder.lexicon.lexiconvariable<builder/lexicon/test/lexiconvariable-py>
   builder.modelbase.aggregationmodel<builder/modelbase/test/aggregationmodel-py>
   builder.modelbase.cashflowmodel<builder/modelbase/test/cashflowmodel-py>
   builder.modelbase.cashflowtable<builder/modelbase/test/cashflowtable-py>
   builder.modelbase.geotable<builder/modelbase/test/geotable-py>
   builder.modelbase.managementmodel<builder/modelbase/test/managementmodel-py>
   builder.modelbase.model<builder/modelbase/test/model-py>
   builder.modelbase.modelbase<builder/modelbase/test/modelbase-py>
   builder.modelbase.operationmodel<builder/modelbase/test/operationmodel-py>
   builder.modelbase.parametertable<builder/modelbase/test/parametertable-py>
   builder.modelbase.predictionmodel<builder/modelbase/test/predictionmodel-py>
   builder.modelbase.table<builder/modelbase/test/table-py>
   builder.modelchain.conditionparser<builder/modelchain/test/conditionparser-py>
   builder.modelchain.modelchain<builder/modelchain/test/modelchain-py>
   builder.modelchain.task<builder/modelchain/test/task-py>
   builder.optimization.exprparser<builder/optimization/test/exprparser-py>
   builder.optimization.objfunc<builder/optimization/test/objfunc-py>
   builder.optimization.opttask<builder/optimization/test/opttask-py>
   builder.output.aggrdef<builder/output/test/aggrdef-py>
   builder.output.exprdef<builder/output/test/exprdef-py>
   builder.output.outputconstraint<builder/output/test/outputconstraint-py>
   builder.simulation.simcontrol<builder/simulation/test/simcontrol-py>
   builder.translation.lexicontranslationtable<builder/translation/test/lexicontranslationtable-py>
   builder.translation.messagetranslationtable<builder/translation/test/messagetranslationtable-py>

Database modules: 

Relational database for storing the input and result data for simulation and optimization and an object database for storing the xml and Python descriptions of the simulator.

.. toctree::
   :maxdepth: 1

   db.datadb.db<db/datadb/test/db-py>
   db.simodb.db<db/simodb/test/db-py>

Data input modules:

.. toctree::
   :maxdepth: 1

   input.importdata<input/test/importdata-py>
   input.importops<input/test/importops-py>

Data matrix modules for internal data handling of the simulator:

.. toctree::
   :maxdepth: 1

   matrix.brancher<matrix/test/brancher-py>
   matrix.handler<matrix/test/handler-py>
   matrix.ind2id<matrix/test/ind2id-py>
   matrix.linkage<matrix/test/linkage-py>
   matrix.matrix<matrix/test/matrix-py>

Optimization modules:

.. toctree::
   :maxdepth: 1

   optimization.genetic_algorithm<optimization/test/genetic_algorithm-py>
   optimization.hero<optimization/test/hero-py>
   optimization.jlp<optimization/test/jlp-py>
   optimization.optimizer<optimization/test/optimizer-py>
   optimization.simulated_annealing<optimization/test/simulated_annealing-py>
   optimization.tabusearch<optimization/test/tabusearch-py>
   optimization.tools.ologger<optimization/tools/test/ologger-py>
   optimization.tools.omatrix<optimization/tools/test/omatrix-py>
   optimization.tools.postfixeval<optimization/tools/test/postfixeval-py>

Output modules:

.. toctree::
   :maxdepth: 1

   output.aggr<output/test/aggr-py>
   output.branching<output/test/branching-py>
   output.by_level<output/test/by_level-py>
   output.expression<output/test/expression-py>
   output.inline<output/test/inline-py>
   output.opres<output/test/opres-py>
   output.out<output/test/out-py>
   output.output<output/test/output-py>
   output.smt<output/test/smt-py>

Simulation modules:

.. toctree::
   :maxdepth: 1

   simulation.condeval<simulation/test/condeval-py>
   simulation.sim<simulation/test/sim-py>
   simulation.caller.aggregationcaller<simulation/caller/test/aggregationcaller-py>
   simulation.caller.caller<simulation/caller/test/caller-py>
   simulation.caller.geotablecaller<simulation/caller/test/geotablecaller-py>
   simulation.caller.managementcaller<simulation/caller/test/managementcaller-py>
   simulation.caller.operationcaller<simulation/caller/test/operationcaller-py>
   simulation.caller.operationmemory<simulation/caller/test/operationmemory-py>
   simulation.caller.paramtablecaller<simulation/caller/test/paramtablecaller-py>
   simulation.caller.predictioncaller<simulation/caller/test/predictioncaller-py>
   simulation.caller.predictionmemory<simulation/caller/test/predictionmemory-py>
   simulation.model.aggregationarg<simulation/model/test/aggregationarg-py>
   simulation.model.operationarg<simulation/model/test/operationarg-py>
   simulation.model.predictionarg<simulation/model/test/predictionarg-py>

Utility modules:

.. toctree::
   :maxdepth: 1

   utils.runnerconfig<utils/test/runnerconfig-py>
   utils.logger<utils/test/logger-py>
   utils.utils<utils/test/utils-py>

Dev notes
#########

.. toctree::
   :maxdepth: 1

   Developer notes<dev_notes>