From cf06faa759ea12a42264d5e6c8efdf2aa43a4b2e Mon Sep 17 00:00:00 2001 From: Nicholas Long Date: Sun, 22 Oct 2023 10:33:39 -0600 Subject: [PATCH] docs: updated repo documentation --- .buildinfo | 2 +- .../geojson_modelica_translator.geojson.html | 35 +-- ...ca_translator.geojson.schemas.Schemas.html | 62 ++-- ...n_modelica_translator.geojson.schemas.html | 35 +-- ...banopt_geojson.GeoJsonValidationError.html | 43 +-- ...json.urbanopt_geojson.UrbanOptGeoJson.html | 56 ++-- ...geojson.urbanopt_geojson.UrbanOptLoad.html | 52 ++-- ...a_translator.geojson.urbanopt_geojson.html | 39 +-- ..._translator.GeoJsonModelicaTranslator.html | 61 ++-- ...n_modelica_translator.ModelicaPackage.html | 57 ++-- ...ranslator.geojson_modelica_translator.html | 35 +-- _autosummary/geojson_modelica_translator.html | 35 +-- ...son_modelica_translator.jinja_filters.html | 35 +-- ...elica_translator.jinja_filters.strcat.html | 43 +-- ...onnectors.couplings.coupling.Coupling.html | 75 ++--- ...r.model_connectors.couplings.coupling.html | 37 +-- ..._connectors.couplings.diagram.Diagram.html | 66 +++-- ...nectors.couplings.diagram.DiagramIcon.html | 62 ++-- ...nectors.couplings.diagram.DiagramNode.html | 63 ++-- ...connectors.couplings.diagram.LoadIcon.html | 62 ++-- ...nectors.couplings.diagram.NetworkIcon.html | 62 ++-- ...connectors.couplings.diagram.NodePort.html | 68 +++-- ...or.model_connectors.couplings.diagram.html | 35 +-- ...nectors.couplings.graph.CouplingGraph.html | 90 +++--- ...ator.model_connectors.couplings.graph.html | 35 +-- ...translator.model_connectors.couplings.html | 35 +-- ...onnectors.couplings.utils.DiagramLine.html | 74 ++--- ...couplings.utils.DiagramTransformation.html | 68 +++-- ...nectors.couplings.utils.find_path_bfs.html | 47 +-- ...ator.model_connectors.couplings.utils.html | 39 +-- ...couplings.utils.parse_diagram_command.html | 43 +-- ...ouplings.utils.parse_diagram_commands.html | 47 +-- ...onnectors.districts.district.District.html | 55 ++-- ...r.model_connectors.districts.district.html | 39 +-- ...rs.districts.district.render_template.html | 47 +-- ...translator.model_connectors.districts.html | 35 +-- ...tems.cooling_indirect.CoolingIndirect.html | 87 +++--- ...rgy_transfer_systems.cooling_indirect.html | 35 +-- ...ergy_transfer_base.EnergyTransferBase.html | 82 ++--- ...transfer_systems.energy_transfer_base.html | 35 +-- ....ets_cold_water_stub.EtsColdWaterStub.html | 87 +++--- ..._transfer_systems.ets_cold_water_stub.html | 35 +-- ...ms.ets_hot_water_stub.EtsHotWaterStub.html | 87 +++--- ...y_transfer_systems.ets_hot_water_stub.html | 35 +-- ...tems.heating_indirect.HeatingIndirect.html | 87 +++--- ...rgy_transfer_systems.heating_indirect.html | 35 +-- ...el_connectors.energy_transfer_systems.html | 35 +-- ..._modelica_translator.model_connectors.html | 35 +-- ...ator.model_connectors.load_connectors.html | 35 +-- ...rs.load_connectors.load_base.LoadBase.html | 87 +++--- ..._connectors.load_connectors.load_base.html | 35 +-- ...onnectors.load_connectors.spawn.Spawn.html | 99 ++++--- ...odel_connectors.load_connectors.spawn.html | 35 +-- ...nectors.load_connectors.teaser.Teaser.html | 111 +++---- ...del_connectors.load_connectors.teaser.html | 35 +-- ...oad_connectors.time_series.TimeSeries.html | 99 ++++--- ...onnectors.load_connectors.time_series.html | 35 +-- ...series_mft_ets_coupling.TimeSeriesMFT.html | 99 ++++--- ...nnectors.time_series_mft_ets_coupling.html | 35 +-- ...model_connectors.model_base.ModelBase.html | 82 ++--- ...ranslator.model_connectors.model_base.html | 35 +-- ..._translator.model_connectors.networks.html | 40 ++- ....networks.network_2_pipe.Network2Pipe.html | 89 +++--- ...el_connectors.networks.network_2_pipe.html | 35 +-- ...nt_water_stub.NetworkAmbientWaterStub.html | 89 +++--- ...s.networks.network_ambient_water_stub.html | 35 +-- ...ors.networks.network_base.NetworkBase.html | 82 ++--- ...odel_connectors.networks.network_base.html | 35 +-- ...ed_water_stub.NetworkChilledWaterStub.html | 99 ++++--- ...s.networks.network_chilled_water_stub.html | 35 +-- ...ribution_pump.NetworkDistributionPump.html | 279 ++++++++++++++++++ ...rs.networks.network_distribution_pump.html | 129 ++++++++ ...ted_water_stub.NetworkHeatedWaterStub.html | 89 +++--- ...rs.networks.network_heated_water_stub.html | 45 ++- ...connectors.plants.borefield.Borefield.html | 87 +++--- ...tor.model_connectors.plants.borefield.html | 35 +-- ...lants.chp.HeatingPlantWithOptionalCHP.html | 87 +++--- ...ranslator.model_connectors.plants.chp.html | 35 +-- ...ors.plants.cooling_plant.CoolingPlant.html | 87 +++--- ...model_connectors.plants.cooling_plant.html | 35 +-- ...ca_translator.model_connectors.plants.html | 35 +-- ...onnectors.plants.plant_base.PlantBase.html | 82 ++--- ...or.model_connectors.plants.plant_base.html | 35 +-- ...tor.modelica.csv_modelica.CSVModelica.html | 61 ++-- ...lica_translator.modelica.csv_modelica.html | 35 +-- .../geojson_modelica_translator.modelica.html | 42 +-- ...tor.modelica.input_parser.InputParser.html | 261 +++++++++------- ...lica_translator.modelica.input_parser.html | 38 +-- ...json_modelica_translator.modelica.lib.html | 45 ++- ...delica_translator.modelica.lib.runner.html | 35 +-- ...or.modelica.lib.runner.om.compile_fmu.html | 43 +-- ...lica.lib.runner.om.configure_mbl_path.html | 48 +-- ...ica_translator.modelica.lib.runner.om.html | 37 +-- ...tor.modelica.lib.runner.om.run_as_fmu.html | 43 +-- ...r.modelica.lib.runner.om.run_with_omc.html | 57 ++-- ...delica.modelica_runner.ModelicaRunner.html | 148 +++++++--- ...a_translator.modelica.modelica_runner.html | 45 ++- ...odelica.simple_gmt_base.SimpleGMTBase.html | 87 +++--- ...a_translator.modelica.simple_gmt_base.html | 35 +-- ...modelica_translator.scaffold.Scaffold.html | 59 ++-- .../geojson_modelica_translator.scaffold.html | 35 +-- ...odelica_translator.utils.ModelicaPath.html | 86 +++--- ...elica_translator.utils.convert_c_to_k.html | 47 +-- ...on_modelica_translator.utils.copytree.html | 43 +-- .../geojson_modelica_translator.utils.html | 39 +-- ...n_modelica_translator.utils.linecount.html | 43 +-- ...modelica_translator.utils.simple_uuid.html | 45 +-- ...ution_pump.NetworkDistributionPump.rst.txt | 42 +++ ...networks.network_distribution_pump.rst.txt | 33 +++ ...anslator.model_connectors.networks.rst.txt | 1 + ...a_translator.modelica.input_parser.rst.txt | 1 - ...ica.modelica_runner.ModelicaRunner.rst.txt | 2 + ...ojson_modelica_translator.modelica.rst.txt | 1 - _static/basic.css | 65 ++-- _static/classic.css | 5 +- _static/doctools.js | 132 +-------- _static/documentation_options.js | 7 +- _static/language_data.js | 2 +- _static/pygments.css | 1 + _static/searchtools.js | 109 ++++--- _static/sidebar.js | 2 +- _static/sphinx_highlight.js | 154 ++++++++++ authors.html | 31 +- changelog.html | 92 ++++-- developer_resources.html | 79 +++-- genindex.html | 112 +++---- getting_started.html | 37 ++- index.html | 33 +-- input_file_documentation.html | 251 +++++++--------- license.html | 31 +- objects.inv | Bin 7380 -> 7370 bytes overview.html | 35 +-- py-modindex.html | 37 ++- search.html | 27 +- searchindex.js | 2 +- 135 files changed, 4152 insertions(+), 3499 deletions(-) create mode 100644 _autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.NetworkDistributionPump.html create mode 100644 _autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.html create mode 100644 _sources/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.NetworkDistributionPump.rst.txt create mode 100644 _sources/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.rst.txt create mode 100644 _static/sphinx_highlight.js diff --git a/.buildinfo b/.buildinfo index dd3efd126..368c8e632 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 5d3c4a4ccda3ee47f91ed6f40b4748eb +config: b8fa7a01b07049f6ebf5df1a5cc0fa3a tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_autosummary/geojson_modelica_translator.geojson.html b/_autosummary/geojson_modelica_translator.geojson.html index 15ec4a86b..a7b8d912b 100644 --- a/_autosummary/geojson_modelica_translator.geojson.html +++ b/_autosummary/geojson_modelica_translator.geojson.html @@ -1,21 +1,18 @@ - - + - + - geojson — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

Navigation

  • previous |
  • - + @@ -50,13 +47,9 @@

    Navigation

    -

    geojson

    +

    geojson

    Modules

    ---- @@ -121,15 +114,15 @@

    Navigation

  • previous |
  • - + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson.schemas.Schemas.html b/_autosummary/geojson_modelica_translator.geojson.schemas.Schemas.html index b13fbab9f..34392b6f6 100644 --- a/_autosummary/geojson_modelica_translator.geojson.schemas.Schemas.html +++ b/_autosummary/geojson_modelica_translator.geojson.schemas.Schemas.html @@ -1,21 +1,18 @@ - - + - + - Schemas — GeoJSON Modelica Translator v0.5.0 documentation - - - + Schemas — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,24 +49,20 @@

    Navigation

    -

    Schemas

    +

    Schemas

    -class geojson_modelica_translator.geojson.schemas.Schemas
    +class geojson_modelica_translator.geojson.schemas.Schemas

    Bases: object

    Class to hold the various schemas

    -__init__()
    +__init__()

    Load in the schemas

    Methods

    geojson_modelica_translator.geojson.schemas

    ---- @@ -84,22 +77,22 @@

    Schemas
    -retrieve(name)
    +retrieve(name)

    name of the schema to retrieve

    -validate(name, instance)
    +validate(name, instance)

    Validate an instance against a loaded schema

    -
    Parameters
    +
    Parameters:
    • name – str, name of the schema to validate against

    • instance – dict, instance to validate

    -
    Returns
    +
    Returns:

    @@ -116,6 +109,21 @@

    Schemas

  • previous |
  • - + @@ -171,8 +179,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson.schemas.html b/_autosummary/geojson_modelica_translator.geojson.schemas.html index 31e39b089..b850b72eb 100644 --- a/_autosummary/geojson_modelica_translator.geojson.schemas.html +++ b/_autosummary/geojson_modelica_translator.geojson.schemas.html @@ -1,21 +1,18 @@ - - + - + - schemas — GeoJSON Modelica Translator v0.5.0 documentation - - - + schemas — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    schemas

    +

    schemas

    Classes

    __init__()

    Load in the schemas

    ---- @@ -119,7 +112,7 @@

    Navigation

  • previous |
  • - + @@ -127,8 +120,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError.html b/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError.html index 95b61dc44..9e895d9b0 100644 --- a/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError.html +++ b/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,10 +49,10 @@

    Navigation

    -

    geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError

    +

    geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError

    -exception geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError
    +exception geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError
    @@ -67,6 +64,16 @@

    geojson_modelica_translator.geojson.urbanopt_geojson.GeoJsonValidationError<

    Schemas()

    Class to hold the various schemas

    ----

    __init__(filename[, building_ids])

    -
    param filename
    +
    param filename:

    str, path to the GeoJSON file to parse

    @@ -101,6 +94,19 @@

    UrbanOptGeoJson

  • previous |
  • - + @@ -156,8 +162,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.UrbanOptLoad.html b/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.UrbanOptLoad.html index 502d26625..2d5243d98 100644 --- a/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.UrbanOptLoad.html +++ b/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.UrbanOptLoad.html @@ -1,21 +1,18 @@ - - + - + - UrbanOptLoad — GeoJSON Modelica Translator v0.5.0 documentation - - - + UrbanOptLoad — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,25 +49,21 @@

    Navigation

    -

    UrbanOptLoad

    +

    UrbanOptLoad

    -class geojson_modelica_translator.geojson.urbanopt_geojson.UrbanOptLoad(feature)
    +class geojson_modelica_translator.geojson.urbanopt_geojson.UrbanOptLoad(feature)

    Bases: object

    An UrbanOptLoad is a container for holding Building-related data in a dictionary. This object does not do much work on the GeoJSON definition of the data at the moment, rather it creates an isolation layer between the GeoJSON data and the GMT.

    -__init__(feature)
    +__init__(feature)

    Methods

    ---- @@ -88,6 +81,19 @@

    UrbanOptLoad

  • previous |
  • - + @@ -143,8 +149,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.html b/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.html index d0ec07264..34103d4ce 100644 --- a/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.html +++ b/_autosummary/geojson_modelica_translator.geojson.urbanopt_geojson.html @@ -1,21 +1,18 @@ - - + - + - urbanopt_geojson — GeoJSON Modelica Translator v0.5.0 documentation - - - + urbanopt_geojson — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    urbanopt_geojson

    +

    urbanopt_geojson

    Classes

    __init__(feature)

    ---- @@ -69,10 +62,6 @@

    Navigation

    UrbanOptGeoJson(filename[, building_ids])

    Root class for parsing an URBANopt GeoJSON file.

    Exceptions

    ---- @@ -134,7 +123,7 @@

    Navigation

  • previous |
  • - + @@ -142,8 +131,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson_modelica_translator.GeoJsonModelicaTranslator.html b/_autosummary/geojson_modelica_translator.geojson_modelica_translator.GeoJsonModelicaTranslator.html index 3e27457ed..722de4e87 100644 --- a/_autosummary/geojson_modelica_translator.geojson_modelica_translator.GeoJsonModelicaTranslator.html +++ b/_autosummary/geojson_modelica_translator.geojson_modelica_translator.GeoJsonModelicaTranslator.html @@ -1,21 +1,18 @@ - - + - + - GeoJsonModelicaTranslator — GeoJSON Modelica Translator v0.5.0 documentation - - - + GeoJsonModelicaTranslator — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,25 +48,25 @@

    Navigation

    -

    GeoJsonModelicaTranslator

    +

    GeoJsonModelicaTranslator

    -class geojson_modelica_translator.geojson_modelica_translator.GeoJsonModelicaTranslator(geojson_filepath, sys_params_filepath, root_dir, project_name)
    +class geojson_modelica_translator.geojson_modelica_translator.GeoJsonModelicaTranslator(geojson_filepath, sys_params_filepath, root_dir, project_name)

    Bases: object

    Main class for using the GeoJSON to Modelica Translator.

    -__init__(geojson_filepath, sys_params_filepath, root_dir, project_name)
    +__init__(geojson_filepath, sys_params_filepath, root_dir, project_name)

    Create an instance of this class

    -
    Parameters
    +
    Parameters:
    • geojson_filepath – str, path to GeoJSON file

    • sys_params_filepath – str, path to system parameters file

    • root_dir – str, where to create the package

    -
    Project_name
    +
    Project_name:

    str, name of the package

    @@ -77,10 +74,6 @@

    GeoJsonModelicaTranslatorMethods

    GeoJsonValidationError

    ---- @@ -92,11 +85,11 @@

    GeoJsonModelicaTranslator
    -to_modelica()
    +to_modelica()

    Generate the modelica package. Call simulate method on the result to run the package

    -
    Returns
    +
    Returns:

    ModelicaPackage

    @@ -113,6 +106,20 @@

    GeoJsonModelicaTranslator

  • previous |
  • - + @@ -167,8 +174,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson_modelica_translator.ModelicaPackage.html b/_autosummary/geojson_modelica_translator.geojson_modelica_translator.ModelicaPackage.html index 37db699da..2400e1934 100644 --- a/_autosummary/geojson_modelica_translator.geojson_modelica_translator.ModelicaPackage.html +++ b/_autosummary/geojson_modelica_translator.geojson_modelica_translator.ModelicaPackage.html @@ -1,21 +1,18 @@ - - + - + - ModelicaPackage — GeoJSON Modelica Translator v0.5.0 documentation - - - + ModelicaPackage — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,23 +48,19 @@

    Navigation

    -

    ModelicaPackage

    +

    ModelicaPackage

    -class geojson_modelica_translator.geojson_modelica_translator.ModelicaPackage(file_to_run, project_path, project_name)
    +class geojson_modelica_translator.geojson_modelica_translator.ModelicaPackage(file_to_run, project_path, project_name)

    Bases: object

    Represents a modelica package which can be simulated

    -__init__(file_to_run, project_path, project_name)
    +__init__(file_to_run, project_path, project_name)

    Methods

    __init__(geojson_filepath, ...)

    Create an instance of this class

    ---- @@ -79,10 +72,10 @@

    ModelicaPackage
    -simulate()
    +simulate()

    Simulate the package.

    -
    Returns
    +
    Returns:

    tuple(bool, pathlib.Path), True or False depending on simulation success followed by the path to the results directory

    @@ -100,6 +93,20 @@

    ModelicaPackage

  • previous |
  • - + @@ -154,8 +161,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.geojson_modelica_translator.html b/_autosummary/geojson_modelica_translator.geojson_modelica_translator.html index 64cec8aad..a0717d908 100644 --- a/_autosummary/geojson_modelica_translator.geojson_modelica_translator.html +++ b/_autosummary/geojson_modelica_translator.geojson_modelica_translator.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -50,13 +47,9 @@

    Navigation

    -

    geojson_modelica_translator

    +

    geojson_modelica_translator

    Classes

    __init__(file_to_run, project_path, project_name)

    ---- @@ -121,15 +114,15 @@

    Navigation

  • previous |
  • - + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.html b/_autosummary/geojson_modelica_translator.html index d605d7891..0405be578 100644 --- a/_autosummary/geojson_modelica_translator.html +++ b/_autosummary/geojson_modelica_translator.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -49,13 +46,9 @@

    Navigation

    -

    geojson_modelica_translator

    +

    geojson_modelica_translator

    Modules

    GeoJsonModelicaTranslator(geojson_filepath, ...)

    Main class for using the GeoJSON to Modelica Translator.

    ---- @@ -135,14 +128,14 @@

    Navigation

  • previous |
  • - + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.jinja_filters.html b/_autosummary/geojson_modelica_translator.jinja_filters.html index 0962ff653..0cc9f5ed7 100644 --- a/_autosummary/geojson_modelica_translator.jinja_filters.html +++ b/_autosummary/geojson_modelica_translator.jinja_filters.html @@ -1,21 +1,18 @@ - - + - + - jinja_filters — GeoJSON Modelica Translator v0.5.0 documentation - - - + jinja_filters — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -50,13 +47,9 @@

    Navigation

    -

    jinja_filters

    +

    jinja_filters

    Functions

    geojson_modelica_translator.geojson

    ---- @@ -118,15 +111,15 @@

    Navigation

  • previous |
  • - + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.jinja_filters.strcat.html b/_autosummary/geojson_modelica_translator.jinja_filters.strcat.html index e1f09e793..2c99a9e25 100644 --- a/_autosummary/geojson_modelica_translator.jinja_filters.strcat.html +++ b/_autosummary/geojson_modelica_translator.jinja_filters.strcat.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator.jinja_filters.strcat — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator.jinja_filters.strcat — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,10 +48,10 @@

    Navigation

    -

    geojson_modelica_translator.jinja_filters.strcat

    +

    geojson_modelica_translator.jinja_filters.strcat

    -geojson_modelica_translator.jinja_filters.strcat(value, append)
    +geojson_modelica_translator.jinja_filters.strcat(value, append)
    @@ -66,6 +63,16 @@

    geojson_modelica_translator.jinja_filters.strcat

  • previous |
  • - + @@ -120,8 +127,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.Coupling.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.Coupling.html index 467ef61b3..17cf8c058 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.Coupling.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.Coupling.html @@ -1,21 +1,18 @@ - - + - + - Coupling — GeoJSON Modelica Translator v0.5.0 documentation - - - + Coupling — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,24 +50,20 @@

    Navigation

    -

    Coupling

    +

    Coupling

    -class geojson_modelica_translator.model_connectors.couplings.coupling.Coupling(model_a, model_b, district_type=None)
    +class geojson_modelica_translator.model_connectors.couplings.coupling.Coupling(model_a, model_b, district_type=None)

    Bases: object

    A Coupling represents a connection/relationship between two models (e.g. a load and ets). More specifically, is used to create the required components and connections between two models.

    -__init__(model_a, model_b, district_type=None)
    +__init__(model_a, model_b, district_type=None)

    Methods

    strcat(value, append)

    ---- @@ -91,10 +84,6 @@

    CouplingAttributes

    __init__(model_a, model_b[, district_type])

    ---- @@ -115,13 +104,13 @@

    Coupling
    -get_load()
    +get_load()

    If there’s a load model in the coupling, it returns the load model. Else it returns None.

    This is used by the district model to find the building’s sys params so it can be passed into the coupling templates

    -
    Returns
    +
    Returns:

    LoadBase | None

    @@ -129,13 +118,13 @@

    Coupling
    -get_other_model(model)
    +get_other_model(model)

    Returns the other model in the coupling

    -
    Parameters
    +
    Parameters:

    model – Model

    -
    Returns
    +
    Returns:

    Model

    @@ -143,13 +132,13 @@

    Coupling
    -render_templates(template_params)
    +render_templates(template_params)

    Renders the shared components and connect statements for the coupling.

    -
    Parameters
    +
    Parameters:

    template_params – dict, parameters for the templates

    -
    Returns
    +
    Returns:

    dict, containing key, values: component_definitions, string; connect_statements, string

    @@ -166,6 +155,22 @@

    Coupling

  • previous |
  • - + @@ -222,8 +227,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.html index 2a6c9400e..2bef2e894 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.coupling.html @@ -1,21 +1,18 @@ - - + - + - coupling — GeoJSON Modelica Translator v0.5.0 documentation - - - + coupling — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,16 +49,12 @@

    Navigation

    -

    coupling

    +

    coupling

    Classes

    component_definitions_template_path

    ---- - +

    Coupling(model_a, model_b[, district_type])

    A Coupling represents a connection/relationship between two models (e.g.

    A Coupling represents a connection/relationship between two models (e.g. a load and ets).

    @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.Diagram.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.Diagram.html index 59a388bc6..f0ace76a0 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.Diagram.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.Diagram.html @@ -1,21 +1,18 @@ - - + - + - Diagram — GeoJSON Modelica Translator v0.5.0 documentation - - - + Diagram — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    Diagram

    +

    Diagram

    -class geojson_modelica_translator.model_connectors.couplings.diagram.Diagram(coupling_graph)
    +class geojson_modelica_translator.model_connectors.couplings.diagram.Diagram(coupling_graph)

    Bases: object

    -__init__(coupling_graph)
    +__init__(coupling_graph)

    Methods

    ---- @@ -80,10 +73,6 @@

    DiagramAttributes

    __init__(coupling_graph)

    ---- @@ -98,10 +87,10 @@

    Diagram
    -property extent
    +property extent

    Returns extent as a string for templating into the district model

    -
    Returns
    +
    Returns:

    str

    @@ -109,11 +98,11 @@

    Diagram
    -to_dict(context_id, is_coupling)
    +to_dict(context_id, is_coupling)

    Get the diagram as a dictionary, to be used for templating for model instances or couplings.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramIcon.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramIcon.html index ac82d918a..9dc643159 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramIcon.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramIcon.html @@ -1,21 +1,18 @@ - - + - + - DiagramIcon — GeoJSON Modelica Translator v0.5.0 documentation - - - + DiagramIcon — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    DiagramIcon

    +

    DiagramIcon

    -class geojson_modelica_translator.model_connectors.couplings.diagram.DiagramIcon
    +class geojson_modelica_translator.model_connectors.couplings.diagram.DiagramIcon

    Bases: ABC

    -__init__()
    +__init__()

    Methods

    extent

    Returns extent as a string for templating into the district model

    ---- @@ -80,10 +73,6 @@

    DiagramIconAttributes

    __init__()

    ---- @@ -95,13 +84,13 @@

    DiagramIcon
    -abstract property height
    +abstract property height

    fraction of a diagram grid cell height (1 is full height, 0.5 is half, etc)

    -abstract property width
    +abstract property width

    fraction of a diagram grid cell width (1 is full width, 0.5 is half, etc)

    @@ -116,6 +105,21 @@

    DiagramIcon

  • previous |
  • - + @@ -172,8 +176,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramNode.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramNode.html index 499628bab..01c962553 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramNode.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.DiagramNode.html @@ -1,21 +1,18 @@ - - + - + - DiagramNode — GeoJSON Modelica Translator v0.5.0 documentation - - - + DiagramNode — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,16 +50,16 @@

    Navigation

    -

    DiagramNode

    +

    DiagramNode

    -class geojson_modelica_translator.model_connectors.couplings.diagram.DiagramNode(context_id, model_name, model_type)
    +class geojson_modelica_translator.model_connectors.couplings.diagram.DiagramNode(context_id, model_name, model_type)

    Bases: object

    -__init__(context_id, model_name, model_type)
    +__init__(context_id, model_name, model_type)
    -
    Parameters
    +
    Parameters:
    • context_id – str, used for “grouping” nodes. E.g. this would be either the coupling id or the model id (depending on where the icon is declared)

    • @@ -75,14 +72,10 @@

      DiagramNodeMethods

    height

    fraction of a diagram grid cell height (1 is full height, 0.5 is half, etc)

    ----

    __init__(context_id, model_name, model_type)

    -
    param context_id
    +
    param context_id:

    str, used for "grouping" nodes. E.g. this would be

    @@ -90,7 +83,7 @@

    DiagramNode

    add_connection(this_port, other_node, other_port)

    -
    param this_port
    +
    param this_port:

    str, name or dotted path of port for this node (should not start with '.' though)

    @@ -100,9 +93,9 @@

    DiagramNode
    -add_connection(this_port, other_node, other_port)
    +add_connection(this_port, other_node, other_port)
    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.LoadIcon.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.LoadIcon.html index 17dcee9ef..015cdd8d5 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.LoadIcon.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.LoadIcon.html @@ -1,21 +1,18 @@ - - + - + - LoadIcon — GeoJSON Modelica Translator v0.5.0 documentation - - - + LoadIcon — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    LoadIcon

    +

    LoadIcon

    -class geojson_modelica_translator.model_connectors.couplings.diagram.LoadIcon
    +class geojson_modelica_translator.model_connectors.couplings.diagram.LoadIcon

    Bases: DiagramIcon

    -__init__()
    +__init__()

    Methods

    ---- @@ -80,10 +73,6 @@

    LoadIconAttributes

    __init__()

    ---- @@ -95,13 +84,13 @@

    LoadIcon
    -property height
    +property height

    fraction of a diagram grid cell height (1 is full height, 0.5 is half, etc)

    -property width
    +property width

    fraction of a diagram grid cell width (1 is full width, 0.5 is half, etc)

    @@ -116,6 +105,21 @@

    LoadIcon

  • previous |
  • - + @@ -172,8 +176,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NetworkIcon.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NetworkIcon.html index 7878481dd..02ed704f7 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NetworkIcon.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NetworkIcon.html @@ -1,21 +1,18 @@ - - + - + - NetworkIcon — GeoJSON Modelica Translator v0.5.0 documentation - - - + NetworkIcon — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    NetworkIcon

    +

    NetworkIcon

    -class geojson_modelica_translator.model_connectors.couplings.diagram.NetworkIcon
    +class geojson_modelica_translator.model_connectors.couplings.diagram.NetworkIcon

    Bases: DiagramIcon

    -__init__()
    +__init__()

    Methods

    height

    fraction of a diagram grid cell height (1 is full height, 0.5 is half, etc)

    ---- @@ -80,10 +73,6 @@

    NetworkIconAttributes

    __init__()

    ---- @@ -95,13 +84,13 @@

    NetworkIcon
    -property height
    +property height

    fraction of a diagram grid cell height (1 is full height, 0.5 is half, etc)

    -property width
    +property width

    fraction of a diagram grid cell width (1 is full width, 0.5 is half, etc)

    @@ -116,6 +105,21 @@

    NetworkIcon

  • previous |
  • - + @@ -172,8 +176,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NodePort.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NodePort.html index b1531b735..3556fc64f 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NodePort.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.NodePort.html @@ -1,21 +1,18 @@ - - + - + - NodePort — GeoJSON Modelica Translator v0.5.0 documentation - - - + NodePort — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    NodePort

    +

    NodePort

    -class geojson_modelica_translator.model_connectors.couplings.diagram.NodePort(node, port)
    +class geojson_modelica_translator.model_connectors.couplings.diagram.NodePort(node, port)

    Bases: tuple

    -__init__()
    +__init__()

    Methods

    height

    fraction of a diagram grid cell height (1 is full height, 0.5 is half, etc)

    ---- @@ -83,10 +76,6 @@

    NodePortAttributes

    __init__()

    ---- @@ -98,26 +87,26 @@

    NodePort
    -count(value, /)
    +count(value, /)

    Return number of occurrences of value.

    -index(value, start=0, stop=9223372036854775807, /)
    +index(value, start=0, stop=9223372036854775807, /)

    Return first index of value.

    Raises ValueError if the value is not present.

    -node
    +node

    Alias for field number 0

    -port
    +port

    Alias for field number 1

    @@ -132,6 +121,23 @@

    NodePort

  • previous |
  • - + @@ -188,8 +194,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.html index f9c8f3205..b62e97dae 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.diagram.html @@ -1,21 +1,18 @@ - - + - + - diagram — GeoJSON Modelica Translator v0.5.0 documentation - - - + diagram — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    diagram

    +

    diagram

    Classes

    node

    Alias for field number 0

    ---- @@ -135,7 +128,7 @@

    Navigation

  • previous |
  • - + @@ -144,8 +137,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.CouplingGraph.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.CouplingGraph.html index b63c15b7a..0386892ca 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.CouplingGraph.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.CouplingGraph.html @@ -1,21 +1,18 @@ - - + - + - CouplingGraph — GeoJSON Modelica Translator v0.5.0 documentation - - - + CouplingGraph — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,23 +50,19 @@

    Navigation

    -

    CouplingGraph

    +

    CouplingGraph

    -class geojson_modelica_translator.model_connectors.couplings.graph.CouplingGraph(couplings)
    +class geojson_modelica_translator.model_connectors.couplings.graph.CouplingGraph(couplings)

    Bases: object

    Manages coupling relationships

    -__init__(couplings)
    +__init__(couplings)

    Methods

    Diagram(coupling_graph)

    ---- @@ -90,10 +83,6 @@

    CouplingGraphAttributes

    __init__(couplings)

    ---- @@ -105,7 +94,7 @@

    CouplingGraph
    -couplings_by_type(model_id)
    +couplings_by_type(model_id)

    Returns the model’s associated couplings keyed by the types of the _other_ model involved

    For example if given model is ets, and its coupled to a load and network, @@ -117,10 +106,10 @@

    CouplingGraph -
    Parameters
    +
    Parameters:

    model_id – str

    -
    Returns
    +
    Returns:

    dict

    @@ -128,7 +117,7 @@

    CouplingGraph
    -directional_index(model_a_id, model_b_id)
    +directional_index(model_a_id, model_b_id)

    Returns the index of model_b within model_a’s adjacency list for model_b’s type.

    For example, if our graph looks like this, and model_b is an ETS @@ -144,29 +133,32 @@

    CouplingGraph +

    }

    Then this method would return 0, because it’s at index 0

    -
    Parameters
    -
      -
    • model_a_id – str, id of model_a

    • -
    • model_b_id – str, id of model_b

    • -
    +
    param model_a_id:
    +

    str, id of model_a

    +
    +
    param model_b_id:
    +

    str, id of model_b

    -
    Returns
    -

    int

    +
    return:
    +

    int

    +

    -get_coupled_load(ets_id)
    +get_coupled_load(ets_id)

    Returns the load coupled to the provided ets

    -
    Parameters
    +
    Parameters:

    ets_id – str

    -
    Returns
    +
    Returns:

    dict

    @@ -183,6 +175,22 @@

    CouplingGraph

  • previous |
  • - + @@ -239,8 +247,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.html index 580008f3f..f4e0868ee 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.graph.html @@ -1,21 +1,18 @@ - - + - + - graph — GeoJSON Modelica Translator v0.5.0 documentation - - - + graph — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    graph

    +

    graph

    Classes

    couplings

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.html index a590d818d..9c922f0a3 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.html @@ -1,21 +1,18 @@ - - + - + - couplings — GeoJSON Modelica Translator v0.5.0 documentation - - - + couplings — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    couplings

    +

    couplings

    Modules

    CouplingGraph(couplings)

    Manages coupling relationships

    ---- @@ -128,7 +121,7 @@

    Navigation

  • previous |
  • - + @@ -136,8 +129,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramLine.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramLine.html index 38e0c6ea4..b5394163d 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramLine.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramLine.html @@ -1,21 +1,18 @@ - - + - + - DiagramLine — GeoJSON Modelica Translator v0.5.0 documentation - - - + DiagramLine — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    DiagramLine

    +

    DiagramLine

    -class geojson_modelica_translator.model_connectors.couplings.utils.DiagramLine(a_name, a_port, b_name, b_port)
    +class geojson_modelica_translator.model_connectors.couplings.utils.DiagramLine(a_name, a_port, b_name, b_port)

    Bases: tuple

    -__init__()
    +__init__()

    Methods

    geojson_modelica_translator.model_connectors.couplings.coupling

    ---- @@ -83,10 +76,6 @@

    DiagramLineAttributes

    __init__()

    ---- @@ -104,37 +93,37 @@

    DiagramLine
    -a_name
    +a_name

    Alias for field number 0

    -a_port
    +a_port

    Alias for field number 1

    -b_name
    +b_name

    Alias for field number 2

    -b_port
    +b_port

    Alias for field number 3

    -count(value, /)
    +count(value, /)

    Return number of occurrences of value.

    -index(value, start=0, stop=9223372036854775807, /)
    +index(value, start=0, stop=9223372036854775807, /)

    Return first index of value.

    Raises ValueError if the value is not present.

    @@ -150,6 +139,25 @@

    DiagramLine

  • previous |
  • - + @@ -206,8 +214,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramTransformation.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramTransformation.html index 0decac30a..76f6f7e96 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramTransformation.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.DiagramTransformation.html @@ -1,21 +1,18 @@ - - + - + - DiagramTransformation — GeoJSON Modelica Translator v0.5.0 documentation - - - + DiagramTransformation — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,22 +50,18 @@

    Navigation

    -

    DiagramTransformation

    +

    DiagramTransformation

    -class geojson_modelica_translator.model_connectors.couplings.utils.DiagramTransformation(model_name, model_type)
    +class geojson_modelica_translator.model_connectors.couplings.utils.DiagramTransformation(model_name, model_type)

    Bases: tuple

    -__init__()
    +__init__()

    Methods

    a_name

    Alias for field number 0

    ---- @@ -83,10 +76,6 @@

    DiagramTransformation

    Attributes

    __init__()

    ---- @@ -98,26 +87,26 @@

    DiagramTransformation
    -count(value, /)
    +count(value, /)

    Return number of occurrences of value.

    -index(value, start=0, stop=9223372036854775807, /)
    +index(value, start=0, stop=9223372036854775807, /)

    Return first index of value.

    Raises ValueError if the value is not present.

    -model_name
    +model_name

    Alias for field number 0

    -model_type
    +model_type

    Alias for field number 1

    @@ -132,6 +121,23 @@

    DiagramTransformation

  • previous |
  • - + @@ -188,8 +194,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs.html index f241912c2..0fa2fdb1b 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,14 +50,14 @@

    Navigation

    -

    geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs

    +

    geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs

    -geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs(matrix, start_row, start_col, end_row, end_col)
    +geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs(matrix, start_row, start_col, end_row, end_col)

    Find path from start to end in the matrix. Matrix items that are None are considered “empty” and traversable. Raises an exception if no path is found.

    -
    Parameters
    +
    Parameters:
    • matrix – list[list[]]

    • start_row – int

    • @@ -69,7 +66,7 @@

      geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs

      end_col – int

    -
    Returns
    +
    Returns:

    list, list of (row, col) tuples

    @@ -84,6 +81,16 @@

    geojson_modelica_translator.model_connectors.couplings.utils.find_path_bfs

  • previous |
  • - + @@ -140,8 +147,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.html index 94c5efc2b..3a6576322 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.html @@ -1,21 +1,18 @@ - - + - + - utils — GeoJSON Modelica Translator v0.5.0 documentation - - - + utils — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    utils

    +

    utils

    Functions

    model_name

    Alias for field number 0

    ---- @@ -73,10 +66,6 @@

    Navigation

    find_path_bfs(matrix, start_row, start_col, ...)

    Find path from start to end in the matrix.

    Classes

    ---- @@ -141,7 +130,7 @@

    Navigation

  • previous |
  • - + @@ -150,8 +139,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command.html b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command.html index 459f2ad62..076c7606b 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,10 +50,10 @@

    Navigation

    -

    geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command

    +

    geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command

    -geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command(str_cmd)
    +geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_command(str_cmd)

    Returns a diagram command or None if it’s not a diagram command

    @@ -69,6 +66,16 @@

    geojson_modelica_translator.model_connectors.couplings.utils.parse_diagram_c

    DiagramLine(a_name, a_port, b_name, b_port)

    ---- @@ -81,7 +74,7 @@

    District
    -to_modelica()
    +to_modelica()

    Generate modelica files for the models as well as the modelica file for the entire district system.

    @@ -97,6 +90,20 @@

    District

  • previous |
  • - + @@ -153,8 +160,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.districts.district.html b/_autosummary/geojson_modelica_translator.model_connectors.districts.district.html index a517af972..362477965 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.districts.district.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.districts.district.html @@ -1,21 +1,18 @@ - - + - + - district — GeoJSON Modelica Translator v0.5.0 documentation - - - + district — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    district

    +

    district

    Functions

    __init__(root_dir, project_name, ...)

    ---- @@ -67,10 +60,6 @@

    Navigation

    render_template(template_name, template_params)

    Helper for rendering a template

    Classes

    ---- @@ -132,7 +121,7 @@

    Navigation

  • previous |
  • - + @@ -141,8 +130,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.districts.district.render_template.html b/_autosummary/geojson_modelica_translator.model_connectors.districts.district.render_template.html index d816d51c9..99e042e55 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.districts.district.render_template.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.districts.district.render_template.html @@ -1,21 +1,18 @@ - - + - + - geojson_modelica_translator.model_connectors.districts.district.render_template — GeoJSON Modelica Translator v0.5.0 documentation - - - + geojson_modelica_translator.model_connectors.districts.district.render_template — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,19 +50,19 @@

    Navigation

    -

    geojson_modelica_translator.model_connectors.districts.district.render_template

    +

    geojson_modelica_translator.model_connectors.districts.district.render_template

    -geojson_modelica_translator.model_connectors.districts.district.render_template(template_name, template_params)
    +geojson_modelica_translator.model_connectors.districts.district.render_template(template_name, template_params)

    Helper for rendering a template

    -
    Parameters
    +
    Parameters:
    • template_name – string, name of template (relative to templates directory)

    • template_params – dict, template parameters

    -
    Returns
    +
    Returns:

    string, templated result

    @@ -80,6 +77,16 @@

    geojson_modelica_translator.model_connectors.districts.district.render_templ

    District(root_dir, project_name, ...)

    Class for modeling entire district energy systems

    ---- @@ -119,7 +112,7 @@

    Navigation

  • previous |
  • - + @@ -127,8 +120,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.CoolingIndirect.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.CoolingIndirect.html index c1acd4be7..b894bc0fc 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.CoolingIndirect.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.CoolingIndirect.html @@ -1,21 +1,18 @@ - - + - + - CoolingIndirect — GeoJSON Modelica Translator v0.5.0 documentation - - - + CoolingIndirect — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    CoolingIndirect

    +

    CoolingIndirect

    -class geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.CoolingIndirect(system_parameters, geojson_load_id)
    +class geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.CoolingIndirect(system_parameters, geojson_load_id)

    Bases: EnergyTransferBase

    -__init__(system_parameters, geojson_load_id)
    +__init__(system_parameters, geojson_load_id)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    CoolingIndirectMethods

    geojson_modelica_translator.model_connectors.districts.district

    ---- @@ -104,10 +97,6 @@

    CoolingIndirectAttributes

    __init__(system_parameters, geojson_load_id)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    CoolingIndirect
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.html index c26769051..dd7b81e56 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect.html @@ -1,21 +1,18 @@ - - + - + - cooling_indirect — GeoJSON Modelica Translator v0.5.0 documentation - - - + cooling_indirect — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    cooling_indirect

    +

    cooling_indirect

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.EnergyTransferBase.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.EnergyTransferBase.html index 454c18184..0009cd015 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.EnergyTransferBase.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.EnergyTransferBase.html @@ -1,21 +1,18 @@ - - + - + - EnergyTransferBase — GeoJSON Modelica Translator v0.5.0 documentation - - - + EnergyTransferBase — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,18 +50,18 @@

    Navigation

    -

    EnergyTransferBase

    +

    EnergyTransferBase

    -class geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.EnergyTransferBase(system_parameters, geojson_load_id)
    +class geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.EnergyTransferBase(system_parameters, geojson_load_id)

    Bases: ModelBase

    Base class of the energy transfer connectors.

    -__init__(system_parameters, geojson_load_id)
    +__init__(system_parameters, geojson_load_id)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -72,10 +69,6 @@

    EnergyTransferBaseMethods

    CoolingIndirect(system_parameters, ...)

    ---- @@ -99,10 +92,6 @@

    EnergyTransferBaseAttributes

    __init__(system_parameters, geojson_load_id)

    Base initializer

    ---- @@ -117,12 +106,12 @@

    EnergyTransferBase
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.html index ac868cf33..eb54171bc 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.energy_transfer_base.html @@ -1,21 +1,18 @@ - - + - + - energy_transfer_base — GeoJSON Modelica Translator v0.5.0 documentation - - - + energy_transfer_base — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    energy_transfer_base

    +

    energy_transfer_base

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.EtsColdWaterStub.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.EtsColdWaterStub.html index 7f32051d3..9e36cfc9b 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.EtsColdWaterStub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.EtsColdWaterStub.html @@ -1,21 +1,18 @@ - - + - + - EtsColdWaterStub — GeoJSON Modelica Translator v0.5.0 documentation - - - + EtsColdWaterStub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    EtsColdWaterStub

    +

    EtsColdWaterStub

    -class geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.EtsColdWaterStub(system_parameters)
    +class geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.EtsColdWaterStub(system_parameters)

    Bases: EnergyTransferBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    EtsColdWaterStubMethods

    EnergyTransferBase(system_parameters, ...)

    Base class of the energy transfer connectors.

    ---- @@ -104,10 +97,6 @@

    EtsColdWaterStubAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    EtsColdWaterStub
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.html index 873a66a2e..d57a70f7b 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_cold_water_stub.html @@ -1,21 +1,18 @@ - - + - + - ets_cold_water_stub — GeoJSON Modelica Translator v0.5.0 documentation - - - + ets_cold_water_stub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    ets_cold_water_stub

    +

    ets_cold_water_stub

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.EtsHotWaterStub.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.EtsHotWaterStub.html index d662d6f63..41b1bc847 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.EtsHotWaterStub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.EtsHotWaterStub.html @@ -1,21 +1,18 @@ - - + - + - EtsHotWaterStub — GeoJSON Modelica Translator v0.5.0 documentation - - - + EtsHotWaterStub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    EtsHotWaterStub

    +

    EtsHotWaterStub

    -class geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.EtsHotWaterStub(system_parameters)
    +class geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.EtsHotWaterStub(system_parameters)

    Bases: EnergyTransferBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    EtsHotWaterStubMethods

    EtsColdWaterStub(system_parameters)

    ---- @@ -104,10 +97,6 @@

    EtsHotWaterStubAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    EtsHotWaterStub
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.html index 9c6b623c7..68492db94 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.ets_hot_water_stub.html @@ -1,21 +1,18 @@ - - + - + - ets_hot_water_stub — GeoJSON Modelica Translator v0.5.0 documentation - - - + ets_hot_water_stub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    ets_hot_water_stub

    +

    ets_hot_water_stub

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.HeatingIndirect.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.HeatingIndirect.html index 97ec8ba7d..97c8af415 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.HeatingIndirect.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.HeatingIndirect.html @@ -1,21 +1,18 @@ - - + - + - HeatingIndirect — GeoJSON Modelica Translator v0.5.0 documentation - - - + HeatingIndirect — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    HeatingIndirect

    +

    HeatingIndirect

    -class geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.HeatingIndirect(system_parameters, geojson_load_id)
    +class geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.HeatingIndirect(system_parameters, geojson_load_id)

    Bases: EnergyTransferBase

    -__init__(system_parameters, geojson_load_id)
    +__init__(system_parameters, geojson_load_id)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    HeatingIndirectMethods

    EtsHotWaterStub(system_parameters)

    ---- @@ -104,10 +97,6 @@

    HeatingIndirectAttributes

    __init__(system_parameters, geojson_load_id)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    HeatingIndirect
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.html index c88491acc..52605d2d0 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.heating_indirect.html @@ -1,21 +1,18 @@ - - + - + - heating_indirect — GeoJSON Modelica Translator v0.5.0 documentation - - - + heating_indirect — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    heating_indirect

    +

    heating_indirect

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.html b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.html index 7d7f599de..509335eae 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.energy_transfer_systems.html @@ -1,21 +1,18 @@ - - + - + - energy_transfer_systems — GeoJSON Modelica Translator v0.5.0 documentation - - - + energy_transfer_systems — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    energy_transfer_systems

    +

    energy_transfer_systems

    Modules

    HeatingIndirect(system_parameters, ...)

    ---- @@ -131,7 +124,7 @@

    Navigation

  • previous |
  • - + @@ -139,8 +132,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.html b/_autosummary/geojson_modelica_translator.model_connectors.html index 5a57cc6b3..076e523c7 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.html @@ -1,21 +1,18 @@ - - + - + - model_connectors — GeoJSON Modelica Translator v0.5.0 documentation - - - + model_connectors — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -50,13 +47,9 @@

    Navigation

    -

    model_connectors

    +

    model_connectors

    Modules

    geojson_modelica_translator.model_connectors.energy_transfer_systems.cooling_indirect

    ---- @@ -136,15 +129,15 @@

    Navigation

  • previous |
  • - + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.html index cb96d12da..cc43de7cd 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.html @@ -1,21 +1,18 @@ - - + - + - load_connectors — GeoJSON Modelica Translator v0.5.0 documentation - - - + load_connectors — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    load_connectors

    +

    load_connectors

    Modules

    geojson_modelica_translator.model_connectors.couplings

    ---- @@ -131,7 +124,7 @@

    Navigation

  • previous |
  • - + @@ -139,8 +132,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.load_base.LoadBase.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.load_base.LoadBase.html index 60db624c6..9ef6361bd 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.load_base.LoadBase.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.load_base.LoadBase.html @@ -1,21 +1,18 @@ - - + - + - LoadBase — GeoJSON Modelica Translator v0.5.0 documentation - - - + LoadBase — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,18 +50,18 @@

    Navigation

    -

    LoadBase

    +

    LoadBase

    -class geojson_modelica_translator.model_connectors.load_connectors.load_base.LoadBase(system_parameters, geojson_load)
    +class geojson_modelica_translator.model_connectors.load_connectors.load_base.LoadBase(system_parameters, geojson_load)

    Bases: ModelBase

    Base class of the load connectors.

    -__init__(system_parameters, geojson_load)
    +__init__(system_parameters, geojson_load)

    Base class for load connectors.

    -
    Parameters
    +
    Parameters:
    • system_parameters – SystemParameter object, the entire system parameter file which will be used to generate this load.

    • @@ -77,10 +74,6 @@

      LoadBaseMethods

    geojson_modelica_translator.model_connectors.load_connectors.load_base

    ---- @@ -107,10 +100,6 @@

    LoadBaseAttributes

    __init__(system_parameters, geojson_load)

    Base class for load connectors.

    ---- @@ -128,10 +117,10 @@

    LoadBase
    -add_building(urbanopt_building, mapper=None)
    +add_building(urbanopt_building, mapper=None)

    Add building to the load to be translated. This is simply a helper method.

    -
    Parameters
    +
    Parameters:

    building_name

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.Spawn.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.Spawn.html index 6520e44a1..87ef242b5 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.Spawn.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.Spawn.html @@ -1,21 +1,18 @@ - - + - + - Spawn — GeoJSON Modelica Translator v0.5.0 documentation - - - + Spawn — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    Spawn

    +

    Spawn

    -class geojson_modelica_translator.model_connectors.load_connectors.spawn.Spawn(system_parameters, geojson_load)
    +class geojson_modelica_translator.model_connectors.load_connectors.spawn.Spawn(system_parameters, geojson_load)

    Bases: LoadBase

    -__init__(system_parameters, geojson_load)
    +__init__(system_parameters, geojson_load)

    Base class for load connectors.

    -
    Parameters
    +
    Parameters:
    • system_parameters – SystemParameter object, the entire system parameter file which will be used to generate this load.

    • @@ -76,10 +73,6 @@

      Spawn

      Methods

    LoadBase(system_parameters, geojson_load)

    Base class of the load connectors.

    ---- @@ -115,10 +108,6 @@

    Spawn

    __init__(system_parameters, geojson_load)

    Base class for load connectors.

    Attributes

    ---- @@ -136,10 +125,10 @@

    Spawn

    building_name

    -add_building(urbanopt_building, mapper=None)
    +add_building(urbanopt_building, mapper=None)

    Add building to the load to be translated. This is simply a helper method.

    -
    Parameters
    +
    Parameters:
    • urbanopt_building – an urbanopt_building (also known as a geojson_load)

    • mapper – placeholder object for mapping between urbanopt_building and load_connector building.

    • @@ -150,12 +139,12 @@

      Spawn
      -copy_required_mo_files(dest_folder, within=None)
      +copy_required_mo_files(dest_folder, within=None)

      Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

      -
      Parameters
      +
      Parameters:
      • dest_folder – String, folder to copy the resulting MO files into.

      • within – String, within clause to be replaced in the .mo file. Note that the original MO file needs to

      • @@ -167,10 +156,10 @@

        Spawn
        -ft2_to_m2(area_in_ft2: float) float
        +ft2_to_m2(area_in_ft2: float) float

        Converts square feet to square meters

        -
        Parameters
        +
        Parameters:

        area_in_ft2 – Area in square feet to be converted to square meters

        @@ -178,7 +167,7 @@

        Spawn
        -post_process(scaffold, keep_original_models=False)
        +post_process(scaffold, keep_original_models=False)

        Cleanup the export of Spawn files into a format suitable for the district-based analysis. This includes the following:

        @@ -188,13 +177,13 @@

        Spawn

    -
    Parameters
    +
    Parameters:
    • scaffold – Scaffold object, Scaffold of the entire directory of the project.

    • keep_original_models – boolean, # TODO

    -
    Returns
    +
    Returns:

    None

    @@ -202,15 +191,15 @@

    Spawn
    -render_instance(template_params)
    +render_instance(template_params)

    Templates the *_Instance file for the model. The templated result will be inserted into the final District Energy System model in order to instantiate/define the model instance.

    -
    Parameters
    +
    Parameters:

    template_params – dict, parameters for the template

    -
    Returns
    +
    Returns:

    tuple (str, str), the templated result followed by the name of the file used for templating

    @@ -218,10 +207,10 @@

    Spawn
    -run_template(template, save_file_name, do_not_add_to_list=False, **kwargs)
    +run_template(template, save_file_name, do_not_add_to_list=False, **kwargs)

    Helper method to create the file from Jinja2’s templating framework.

    -
    Parameters
    +
    Parameters:
    -
    Returns
    +
    Returns:

    None

    @@ -237,10 +226,10 @@

    Spawn
    -to_modelica(scaffold, keep_original_models=False)
    +to_modelica(scaffold, keep_original_models=False)

    Create spawn models based on the data in the buildings and geojsons

    -
    Parameters
    +
    Parameters:

    scaffold – Scaffold object, Scaffold of the entire directory of the project.

    @@ -257,6 +246,26 @@

    Spawn

  • previous |
  • - + @@ -313,8 +322,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.html index ca308351f..d745a249c 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.spawn.html @@ -1,21 +1,18 @@ - - + - + - spawn — GeoJSON Modelica Translator v0.5.0 documentation - - - + spawn — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    spawn

    +

    spawn

    Classes

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.teaser.Teaser.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.teaser.Teaser.html index 11929ed42..7dcdc2e73 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.teaser.Teaser.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.teaser.Teaser.html @@ -1,21 +1,18 @@ - - + - + - Teaser — GeoJSON Modelica Translator v0.5.0 documentation - - - + Teaser — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,19 +50,19 @@

    Navigation

    -

    Teaser

    +

    Teaser

    -class geojson_modelica_translator.model_connectors.load_connectors.teaser.Teaser(system_parameters, geojson_load)
    +class geojson_modelica_translator.model_connectors.load_connectors.teaser.Teaser(system_parameters, geojson_load)

    Bases: LoadBase

    TEASER is different than the other model connectors since TEASER creates all of the building models with multiple thermal zones when running, at which point each building then needs to be processed.

    -__init__(system_parameters, geojson_load)
    +__init__(system_parameters, geojson_load)

    Base class for load connectors.

    -
    Parameters
    +
    Parameters:
    • system_parameters – SystemParameter object, the entire system parameter file which will be used to generate this load.

    • @@ -78,10 +75,6 @@

      TeaserMethods

    Spawn(system_parameters, geojson_load)

    ---- @@ -123,10 +116,6 @@

    Teaser

    Attributes

    __init__(system_parameters, geojson_load)

    Base class for load connectors.

    ---- @@ -144,10 +133,10 @@

    Teaser
    -add_building(urbanopt_building, mapper=None)
    +add_building(urbanopt_building, mapper=None)

    Add building to the load to be translated. This is simply a helper method.

    -
    Parameters
    +
    Parameters:

    building_name

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.TimeSeries.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.TimeSeries.html index 475c03412..a1fc094ee 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.TimeSeries.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.TimeSeries.html @@ -1,21 +1,18 @@ - - + - + - TimeSeries — GeoJSON Modelica Translator v0.5.0 documentation - - - + TimeSeries — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    TimeSeries

    +

    TimeSeries

    -class geojson_modelica_translator.model_connectors.load_connectors.time_series.TimeSeries(system_parameters, geojson_load)
    +class geojson_modelica_translator.model_connectors.load_connectors.time_series.TimeSeries(system_parameters, geojson_load)

    Bases: LoadBase

    -__init__(system_parameters, geojson_load)
    +__init__(system_parameters, geojson_load)

    Base class for load connectors.

    -
    Parameters
    +
    Parameters:
    • system_parameters – SystemParameter object, the entire system parameter file which will be used to generate this load.

    • @@ -76,10 +73,6 @@

      TimeSeriesMethods

    Teaser(system_parameters, geojson_load)

    TEASER is different than the other model connectors since TEASER creates all of the building models with multiple thermal zones when running, at which point each building then needs to be processed.

    ---- @@ -115,10 +108,6 @@

    TimeSeriesAttributes

    __init__(system_parameters, geojson_load)

    Base class for load connectors.

    ---- @@ -136,10 +125,10 @@

    TimeSeries
    -add_building(urbanopt_building, mapper=None)
    +add_building(urbanopt_building, mapper=None)

    Add building to the load to be translated. This is simply a helper method.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.html index 2ae8b65b7..badc29651 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series.html @@ -1,21 +1,18 @@ - - + - + - time_series — GeoJSON Modelica Translator v0.5.0 documentation - - - + time_series — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    time_series

    +

    time_series

    Classes

    building_name

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.TimeSeriesMFT.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.TimeSeriesMFT.html index f3195523c..63cffce21 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.TimeSeriesMFT.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.TimeSeriesMFT.html @@ -1,21 +1,18 @@ - - + - + - TimeSeriesMFT — GeoJSON Modelica Translator v0.5.0 documentation - - - + TimeSeriesMFT — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    TimeSeriesMFT

    +

    TimeSeriesMFT

    -class geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.TimeSeriesMFT(system_parameters, geojson_load)
    +class geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.TimeSeriesMFT(system_parameters, geojson_load)

    Bases: LoadBase

    -__init__(system_parameters, geojson_load)
    +__init__(system_parameters, geojson_load)

    Base class for load connectors.

    -
    Parameters
    +
    Parameters:
    • system_parameters – SystemParameter object, the entire system parameter file which will be used to generate this load.

    • @@ -76,10 +73,6 @@

      TimeSeriesMFTMethods

    TimeSeries(system_parameters, geojson_load)

    ---- @@ -115,10 +108,6 @@

    TimeSeriesMFTAttributes

    __init__(system_parameters, geojson_load)

    Base class for load connectors.

    ---- @@ -136,10 +125,10 @@

    TimeSeriesMFT
    -add_building(urbanopt_building, mapper=None)
    +add_building(urbanopt_building, mapper=None)

    Add building to the load to be translated. This is simply a helper method.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.html b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.html index 82d8ba259..b075eb4e6 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.load_connectors.time_series_mft_ets_coupling.html @@ -1,21 +1,18 @@ - - + - + - time_series_mft_ets_coupling — GeoJSON Modelica Translator v0.5.0 documentation - - - + time_series_mft_ets_coupling — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    time_series_mft_ets_coupling

    +

    time_series_mft_ets_coupling

    Classes

    building_name

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.model_base.ModelBase.html b/_autosummary/geojson_modelica_translator.model_connectors.model_base.ModelBase.html index 79dfb1377..d0b66934a 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.model_base.ModelBase.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.model_base.ModelBase.html @@ -1,21 +1,18 @@ - - + - + - ModelBase — GeoJSON Modelica Translator v0.5.0 documentation - - - + ModelBase — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,19 +49,19 @@

    Navigation

    -

    ModelBase

    +

    ModelBase

    -class geojson_modelica_translator.model_connectors.model_base.ModelBase(system_parameters, template_dir)
    +class geojson_modelica_translator.model_connectors.model_base.ModelBase(system_parameters, template_dir)

    Bases: object

    Base class of the model connectors. The connectors can utilize various methods to create a building (or other feature) to a detailed Modelica connection. For example, a simple RC model (using TEASER), a ROM, CSV file, etc.

    -__init__(system_parameters, template_dir)
    +__init__(system_parameters, template_dir)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -72,10 +69,6 @@

    ModelBaseMethods

    TimeSeriesMFT(system_parameters, geojson_load)

    ---- @@ -99,10 +92,6 @@

    ModelBaseAttributes

    __init__(system_parameters, template_dir)

    Base initializer

    ---- @@ -114,12 +103,12 @@

    ModelBase
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.model_base.html b/_autosummary/geojson_modelica_translator.model_connectors.model_base.html index 93095233f..5d374dfc8 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.model_base.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.model_base.html @@ -1,21 +1,18 @@ - - + - + - model_base — GeoJSON Modelica Translator v0.5.0 documentation - - - + model_base — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    model_base

    +

    model_base

    Classes

    instance_template_path

    ---- @@ -119,7 +112,7 @@

    Navigation

  • previous |
  • - + @@ -127,8 +120,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.html index 3488859bb..0d6ee960e 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.html @@ -1,21 +1,18 @@ - - + - + - networks — GeoJSON Modelica Translator v0.5.0 documentation - - - + networks — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    networks

    +

    networks

    Modules

    ModelBase(system_parameters, template_dir)

    Base class of the model connectors.

    ---- @@ -71,7 +64,10 @@

    Navigation

    - + + + + @@ -131,7 +127,7 @@

    Navigation

  • previous |
  • - + @@ -139,8 +135,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.Network2Pipe.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.Network2Pipe.html index 1f10d5b4b..f0a7054ba 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.Network2Pipe.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.Network2Pipe.html @@ -1,21 +1,18 @@ - - + - + - Network2Pipe — GeoJSON Modelica Translator v0.5.0 documentation - - - + Network2Pipe — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    Network2Pipe

    +

    Network2Pipe

    -class geojson_modelica_translator.model_connectors.networks.network_2_pipe.Network2Pipe(system_parameters)
    +class geojson_modelica_translator.model_connectors.networks.network_2_pipe.Network2Pipe(system_parameters)

    Bases: NetworkBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    Network2PipeMethods

    geojson_modelica_translator.model_connectors.networks.network_2_pipe

    geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub

    geojson_modelica_translator.model_connectors.networks.network_heated_water_stub

    geojson_modelica_translator.model_connectors.networks.network_distribution_pump

    geojson_modelica_translator.model_connectors.networks.network_heated_water_stub

    ---- @@ -99,7 +92,7 @@

    Network2Pipe

    __init__(system_parameters)

    Base initializer

    to_modelica(scaffold)

    -
    param scaffold
    +
    param scaffold:

    Scaffold object, Scaffold of the entire directory of the project.

    @@ -109,10 +102,6 @@

    Network2PipeAttributes

    ---- @@ -127,12 +116,12 @@

    Network2Pipe
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.html index 8048f1be5..0f4bfdbdb 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_2_pipe.html @@ -1,21 +1,18 @@ - - + - + - network_2_pipe — GeoJSON Modelica Translator v0.5.0 documentation - - - + network_2_pipe — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    network_2_pipe

    +

    network_2_pipe

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.NetworkAmbientWaterStub.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.NetworkAmbientWaterStub.html index 01fb72cba..eebfec654 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.NetworkAmbientWaterStub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.NetworkAmbientWaterStub.html @@ -1,21 +1,18 @@ - - + - + - NetworkAmbientWaterStub — GeoJSON Modelica Translator v0.5.0 documentation - - - + NetworkAmbientWaterStub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    NetworkAmbientWaterStub

    +

    NetworkAmbientWaterStub

    -class geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.NetworkAmbientWaterStub(system_parameters)
    +class geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.NetworkAmbientWaterStub(system_parameters)

    Bases: NetworkBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    NetworkAmbientWaterStubMethods

    Network2Pipe(system_parameters)

    ---- @@ -99,7 +92,7 @@

    NetworkAmbientWaterStub

    __init__(system_parameters)

    Base initializer

    to_modelica(scaffold)

    -
    param scaffold
    +
    param scaffold:

    Scaffold object, Scaffold of the entire directory of the project.

    @@ -109,10 +102,6 @@

    NetworkAmbientWaterStub

    Attributes

    ---- @@ -127,12 +116,12 @@

    NetworkAmbientWaterStub
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.html index fa4af5429..2c791d38b 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_ambient_water_stub.html @@ -1,21 +1,18 @@ - - + - + - network_ambient_water_stub — GeoJSON Modelica Translator v0.5.0 documentation - - - + network_ambient_water_stub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    network_ambient_water_stub

    +

    network_ambient_water_stub

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.NetworkBase.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.NetworkBase.html index 40bce2bde..a039459c8 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.NetworkBase.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.NetworkBase.html @@ -1,21 +1,18 @@ - - + - + - NetworkBase — GeoJSON Modelica Translator v0.5.0 documentation - - - + NetworkBase — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,18 +50,18 @@

    Navigation

    -

    NetworkBase

    +

    NetworkBase

    -class geojson_modelica_translator.model_connectors.networks.network_base.NetworkBase(system_parameters)
    +class geojson_modelica_translator.model_connectors.networks.network_base.NetworkBase(system_parameters)

    Bases: ModelBase

    Base class of the network connectors.

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -72,10 +69,6 @@

    NetworkBaseMethods

    NetworkAmbientWaterStub(system_parameters)

    ---- @@ -99,10 +92,6 @@

    NetworkBaseAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -117,12 +106,12 @@

    NetworkBase
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.html index 6519f89ed..c95c321f6 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_base.html @@ -1,21 +1,18 @@ - - + - + - network_base — GeoJSON Modelica Translator v0.5.0 documentation - - - + network_base — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    network_base

    +

    network_base

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.NetworkChilledWaterStub.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.NetworkChilledWaterStub.html index b572b2983..8a884b2f2 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.NetworkChilledWaterStub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.NetworkChilledWaterStub.html @@ -1,25 +1,22 @@ - - + - + - NetworkChilledWaterStub — GeoJSON Modelica Translator v0.5.0 documentation - - - + NetworkChilledWaterStub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + - +

    NetworkBase(system_parameters)

    Base class of the network connectors.

    ---- @@ -99,7 +92,7 @@

    NetworkChilledWaterStub

    __init__(system_parameters)

    Base initializer

    to_modelica(scaffold)

    -
    param scaffold
    +
    param scaffold:

    Scaffold object, Scaffold of the entire directory of the project.

    @@ -109,10 +102,6 @@

    NetworkChilledWaterStub

    Attributes

    ---- @@ -127,12 +116,12 @@

    NetworkChilledWaterStub
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.html index 453d1af54..2e0559ef0 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_chilled_water_stub.html @@ -1,21 +1,18 @@ - - + - + - network_chilled_water_stub — GeoJSON Modelica Translator v0.5.0 documentation - - - + network_chilled_water_stub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    network_chilled_water_stub

    +

    network_chilled_water_stub

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.NetworkDistributionPump.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.NetworkDistributionPump.html new file mode 100644 index 000000000..862b902c6 --- /dev/null +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.NetworkDistributionPump.html @@ -0,0 +1,279 @@ + + + + + + + + NetworkDistributionPump — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    NetworkDistributionPump

    +
    +
    +class geojson_modelica_translator.model_connectors.networks.network_distribution_pump.NetworkDistributionPump(system_parameters)
    +

    Bases: NetworkBase

    +
    +
    +__init__(system_parameters)
    +

    Base initializer

    +
    +
    Parameters:
    +

    system_parameters – SystemParameters object

    +
    +
    +
    + +

    Methods

    +

    NetworkChilledWaterStub(system_parameters)

    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    __init__(system_parameters)

    Base initializer

    copy_required_mo_files(dest_folder[, within])

    Copy any required_mo_files to the destination and update the within clause if defined.

    ft2_to_m2(area_in_ft2)

    Converts square feet to square meters

    get_modelica_type(scaffold)

    render_instance(template_params)

    Templates the *_Instance file for the model. The templated result will be inserted into the final District Energy System model in order to instantiate/define the model instance.

    run_template(template, save_file_name[, ...])

    Helper method to create the file from Jinja2's templating framework.

    to_dict(scaffold)

    to_modelica(scaffold)

    +
    param scaffold:
    +

    Scaffold object, Scaffold of the entire directory of the project.

    +
    +
    +

    +

    Attributes

    + + + + + + + + + + + + +

    instance_template_path

    model_name

    simple_gmt_type

    +
    +
    +copy_required_mo_files(dest_folder, within=None)
    +

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo +files need to be added as full paths to the required_mo_files member variable in the connectors derived +classes.

    +
    +
    Parameters:
    +
      +
    • dest_folder – String, folder to copy the resulting MO files into.

    • +
    • within – String, within clause to be replaced in the .mo file. Note that the original MO file needs to

    • +
    +
    +
    +

    have a within clause defined to be replaced.

    +
    + +
    +
    +ft2_to_m2(area_in_ft2: float) float
    +

    Converts square feet to square meters

    +
    +
    Parameters:
    +

    area_in_ft2 – Area in square feet to be converted to square meters

    +
    +
    +
    + +
    +
    +render_instance(template_params)
    +

    Templates the *_Instance file for the model. The templated result will +be inserted into the final District Energy System model in order to +instantiate/define the model instance.

    +
    +
    Parameters:
    +

    template_params – dict, parameters for the template

    +
    +
    Returns:
    +

    tuple (str, str), the templated result followed by the name of the file used for templating

    +
    +
    +
    + +
    +
    +run_template(template, save_file_name, do_not_add_to_list=False, **kwargs)
    +

    Helper method to create the file from Jinja2’s templating framework.

    +
    +
    Parameters:
    +
      +
    • template – object, Jinja template from the template_env.get_template() command.

    • +
    • save_file_name – string, fully qualified path to save the rendered template to.

    • +
    • do_not_add_to_list – boolean, set to true if you do not want the file to be added to the package.order

    • +
    • kwargs – These are the arguments that need to be passed to the template.

    • +
    +
    +
    Returns:
    +

    None

    +
    +
    +
    + +
    +
    +to_modelica(scaffold)
    +
    +
    Parameters:
    +

    scaffold – Scaffold object, Scaffold of the entire directory of the project.

    +
    +
    +
    + + + + + + +
    + + + + +
    + + + + + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.html new file mode 100644 index 000000000..741b66fc9 --- /dev/null +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_distribution_pump.html @@ -0,0 +1,129 @@ + + + + + + + + network_distribution_pump — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + + + + + + + + + + + + + +
    +
    +
    +
    + +
    +

    network_distribution_pump

    +

    Classes

    + + + + + + +

    NetworkDistributionPump(system_parameters)

    +
    + + +
    +
    +
    +
    + +
    +
    + + + + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.NetworkHeatedWaterStub.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.NetworkHeatedWaterStub.html index 8803d5c0c..8366dc2e9 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.NetworkHeatedWaterStub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.NetworkHeatedWaterStub.html @@ -1,21 +1,18 @@ - - + - + - NetworkHeatedWaterStub — GeoJSON Modelica Translator v0.5.0 documentation - - - + NetworkHeatedWaterStub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    NetworkHeatedWaterStub

    +

    NetworkHeatedWaterStub

    -class geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.NetworkHeatedWaterStub(system_parameters)
    +class geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.NetworkHeatedWaterStub(system_parameters)

    Bases: NetworkBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    NetworkHeatedWaterStubMethods

    ---- @@ -99,7 +92,7 @@

    NetworkHeatedWaterStub

    __init__(system_parameters)

    Base initializer

    to_modelica(scaffold)

    -
    param scaffold
    +
    param scaffold:

    Scaffold object, Scaffold of the entire directory of the project.

    @@ -109,10 +102,6 @@

    NetworkHeatedWaterStub

    Attributes

    ---- @@ -127,12 +116,12 @@

    NetworkHeatedWaterStub
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.html b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.html index e71d63c51..0035cd777 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.networks.network_heated_water_stub.html @@ -1,26 +1,23 @@ - - + - + - network_heated_water_stub — GeoJSON Modelica Translator v0.5.0 documentation - - - + network_heated_water_stub — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + - +

    instance_template_path

    ---- @@ -76,8 +69,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.Borefield.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.Borefield.html index 8c079a52a..ba258ffc2 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.Borefield.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.Borefield.html @@ -1,21 +1,18 @@ - - + - + - Borefield — GeoJSON Modelica Translator v0.5.0 documentation - - - + Borefield — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    Borefield

    +

    Borefield

    -class geojson_modelica_translator.model_connectors.plants.borefield.Borefield(system_parameters)
    +class geojson_modelica_translator.model_connectors.plants.borefield.Borefield(system_parameters)

    Bases: PlantBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    BorefieldMethods

    NetworkHeatedWaterStub(system_parameters)

    ---- @@ -104,10 +97,6 @@

    BorefieldAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    Borefield
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.html index 622c7d271..7504d6e41 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.borefield.html @@ -1,21 +1,18 @@ - - + - + - borefield — GeoJSON Modelica Translator v0.5.0 documentation - - - + borefield — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    borefield

    +

    borefield

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.HeatingPlantWithOptionalCHP.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.HeatingPlantWithOptionalCHP.html index a2e468fce..025594b9e 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.HeatingPlantWithOptionalCHP.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.HeatingPlantWithOptionalCHP.html @@ -1,21 +1,18 @@ - - + - + - HeatingPlantWithOptionalCHP — GeoJSON Modelica Translator v0.5.0 documentation - - - + HeatingPlantWithOptionalCHP — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    HeatingPlantWithOptionalCHP

    +

    HeatingPlantWithOptionalCHP

    -class geojson_modelica_translator.model_connectors.plants.chp.HeatingPlantWithOptionalCHP(system_parameters)
    +class geojson_modelica_translator.model_connectors.plants.chp.HeatingPlantWithOptionalCHP(system_parameters)

    Bases: PlantBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    HeatingPlantWithOptionalCHPMethods

    Borefield(system_parameters)

    ---- @@ -104,10 +97,6 @@

    HeatingPlantWithOptionalCHPAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    HeatingPlantWithOptionalCHP
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.html index 75816597c..2e6c3cb01 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.chp.html @@ -1,21 +1,18 @@ - - + - + - chp — GeoJSON Modelica Translator v0.5.0 documentation - - - + chp — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    chp

    +

    chp

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.CoolingPlant.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.CoolingPlant.html index b28cca3f0..9c39b0489 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.CoolingPlant.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.CoolingPlant.html @@ -1,21 +1,18 @@ - - + - + - CoolingPlant — GeoJSON Modelica Translator v0.5.0 documentation - - - + CoolingPlant — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,17 +50,17 @@

    Navigation

    -

    CoolingPlant

    +

    CoolingPlant

    -class geojson_modelica_translator.model_connectors.plants.cooling_plant.CoolingPlant(system_parameters)
    +class geojson_modelica_translator.model_connectors.plants.cooling_plant.CoolingPlant(system_parameters)

    Bases: PlantBase

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -71,10 +68,6 @@

    CoolingPlantMethods

    HeatingPlantWithOptionalCHP(system_parameters)

    ---- @@ -104,10 +97,6 @@

    CoolingPlantAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -122,12 +111,12 @@

    CoolingPlant
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.html index 6cb6a4c95..72cd4c487 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.cooling_plant.html @@ -1,21 +1,18 @@ - - + - + - cooling_plant — GeoJSON Modelica Translator v0.5.0 documentation - - - + cooling_plant — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    cooling_plant

    +

    cooling_plant

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.html index c669d79d3..4a81461fb 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.html @@ -1,21 +1,18 @@ - - + - + - plants — GeoJSON Modelica Translator v0.5.0 documentation - - - + plants — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    plants

    +

    plants

    Modules

    CoolingPlant(system_parameters)

    ---- @@ -128,7 +121,7 @@

    Navigation

  • previous |
  • - + @@ -136,8 +129,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.PlantBase.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.PlantBase.html index 730181a32..bb106a2ec 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.PlantBase.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.PlantBase.html @@ -1,21 +1,18 @@ - - + - + - PlantBase — GeoJSON Modelica Translator v0.5.0 documentation - - - + PlantBase — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -53,18 +50,18 @@

    Navigation

    -

    PlantBase

    +

    PlantBase

    -class geojson_modelica_translator.model_connectors.plants.plant_base.PlantBase(system_parameters)
    +class geojson_modelica_translator.model_connectors.plants.plant_base.PlantBase(system_parameters)

    Bases: ModelBase

    Base class of the central plants.

    -__init__(system_parameters)
    +__init__(system_parameters)

    Base initializer

    -
    Parameters
    +
    Parameters:

    system_parameters – SystemParameters object

    @@ -72,10 +69,6 @@

    PlantBaseMethods

    geojson_modelica_translator.model_connectors.plants.borefield

    ---- @@ -99,10 +92,6 @@

    PlantBaseAttributes

    __init__(system_parameters)

    Base initializer

    ---- @@ -117,12 +106,12 @@

    PlantBase
    -copy_required_mo_files(dest_folder, within=None)
    +copy_required_mo_files(dest_folder, within=None)

    Copy any required_mo_files to the destination and update the within clause if defined. The required mo files need to be added as full paths to the required_mo_files member variable in the connectors derived classes.

    -
    Parameters
    +
    Parameters:
    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.html b/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.html index e1c54ad93..af4dbddd4 100644 --- a/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.html +++ b/_autosummary/geojson_modelica_translator.model_connectors.plants.plant_base.html @@ -1,21 +1,18 @@ - - + - + - plant_base — GeoJSON Modelica Translator v0.5.0 documentation - - - + plant_base — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,13 +49,9 @@

    Navigation

    -

    plant_base

    +

    plant_base

    Classes

    instance_template_path

    ---- @@ -120,7 +113,7 @@

    Navigation

  • previous |
  • - + @@ -129,8 +122,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.modelica.csv_modelica.CSVModelica.html b/_autosummary/geojson_modelica_translator.modelica.csv_modelica.CSVModelica.html index b0dd3d41e..6f0680972 100644 --- a/_autosummary/geojson_modelica_translator.modelica.csv_modelica.CSVModelica.html +++ b/_autosummary/geojson_modelica_translator.modelica.csv_modelica.CSVModelica.html @@ -1,21 +1,18 @@ - - + - + - CSVModelica — GeoJSON Modelica Translator v0.5.0 documentation - - - + CSVModelica — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -52,14 +49,14 @@

    Navigation

    -

    CSVModelica

    +

    CSVModelica

    -class geojson_modelica_translator.modelica.csv_modelica.CSVModelica(input_csv_file_path, sig_fig=3)
    +class geojson_modelica_translator.modelica.csv_modelica.CSVModelica(input_csv_file_path, sig_fig=3)

    Bases: object

    -__init__(input_csv_file_path, sig_fig=3)
    +__init__(input_csv_file_path, sig_fig=3)

    Convert a CSV file into the format required by Modelica. Expects a file resulting from https://github.com/urbanopt/DES_HVAC/tree/develop/Measures/export_time_series_modelica, which is included in the URBANopt SDK (potentially via common-measures-gem). @@ -73,7 +70,7 @@

    CSVModelica -
    Parameters
    +
    Parameters:

    PlantBase(system_parameters)

    Base class of the central plants.

    ---- @@ -100,18 +93,18 @@

    CSVModelica
    -timeseries_to_modelica_data(output_modelica_file_name, energyplus_timesteps_per_hour=4, data_type='double', overwrite=True)
    +timeseries_to_modelica_data(output_modelica_file_name, energyplus_timesteps_per_hour=4, data_type='double', overwrite=True)

    Convert the loaded data to the format needed for Modelica by adding in the nominal heating water mass flow rate and the nominal cooling water mass flow rate into the header.

    -
    Parameters
    +
    Parameters:
    • output_modelica_file_name – string, The path to the desired output file name.

    • data_type – string, data type being converted, defaults to double

    • overwrite – boolean, if the resulting file exists, then overwrite, defaults to True.

    -
    Returns
    +
    Returns:

    file created to be ingested into Modelica

    @@ -128,6 +121,20 @@

    CSVModelica

  • previous |
  • - + @@ -183,8 +190,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.modelica.csv_modelica.html b/_autosummary/geojson_modelica_translator.modelica.csv_modelica.html index d651037cf..e7d9334c2 100644 --- a/_autosummary/geojson_modelica_translator.modelica.csv_modelica.html +++ b/_autosummary/geojson_modelica_translator.modelica.csv_modelica.html @@ -1,21 +1,18 @@ - - + - + - csv_modelica — GeoJSON Modelica Translator v0.5.0 documentation - - - + csv_modelica — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,13 +48,9 @@

    Navigation

    -

    csv_modelica

    +

    csv_modelica

    Classes

    __init__(input_csv_file_path[, sig_fig])

    Convert a CSV file into the format required by Modelica.

    ---- @@ -119,7 +112,7 @@

    Navigation

  • previous |
  • - + @@ -127,8 +120,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.modelica.html b/_autosummary/geojson_modelica_translator.modelica.html index 3b0801900..0de0d640b 100644 --- a/_autosummary/geojson_modelica_translator.modelica.html +++ b/_autosummary/geojson_modelica_translator.modelica.html @@ -1,21 +1,18 @@ - - + - + - modelica — GeoJSON Modelica Translator v0.5.0 documentation - - - + modelica — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -50,13 +47,9 @@

    Navigation

    -

    modelica

    +

    modelica

    Modules

    CSVModelica(input_csv_file_path[, sig_fig])

    ---- @@ -67,13 +60,10 @@

    Navigation

    - - - - + - + @@ -133,15 +123,15 @@

    Navigation

  • previous |
  • - + \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.modelica.input_parser.InputParser.html b/_autosummary/geojson_modelica_translator.modelica.input_parser.InputParser.html index 4f6f158d4..d29e6fce5 100644 --- a/_autosummary/geojson_modelica_translator.modelica.input_parser.InputParser.html +++ b/_autosummary/geojson_modelica_translator.modelica.input_parser.InputParser.html @@ -1,25 +1,22 @@ - - + - + - InputParser — GeoJSON Modelica Translator v0.5.0 documentation - - - + InputParser — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + - +

    geojson_modelica_translator.modelica.csv_modelica

    geojson_modelica_translator.modelica.lib

    geojson_modelica_translator.modelica.modelica_mos_file

    geojson_modelica_translator.modelica.modelica_runner

    geojson_modelica_translator.modelica.modelica_runner

    geojson_modelica_translator.modelica.simple_gmt_base

    geojson_modelica_translator.modelica.simple_gmt_base

    ---- - + @@ -86,13 +93,13 @@

    InputParser

    - + - - + + @@ -125,14 +132,14 @@

    InputParser
    -add_connect(a, b, annotation)
    +add_connect(a: str, b: str, annotation: str) None

    Add a new connection of port a to port b. The annotation will be appended on a new line.

    -
    Parameters
    +
    Parameters:
      -
    • a – string, port a

    • -
    • b – string, port b

    • -
    • annotation – string, description

    • +
    • a (str) – port a

    • +
    • b (str) – port b

    • +
    • annotation (str) – description

    @@ -140,14 +147,14 @@

    InputParser
    -add_model_object(model_name, model_instance, data)
    +add_model_object(model_name: str, model_instance: str, data: List[str]) None

    Add a new model object to the model

    -
    Parameters
    +
    Parameters:
      -
    • model_name – string

    • -
    • model_instance – string

    • -
    • data – list of strings

    • +
    • model_name (str) – name of the model

    • +
    • model_instance (str) – model instance name

    • +
    • data (List[str]) – list of data to add

    @@ -155,15 +162,15 @@

    InputParser
    -add_parameter(var_type, var_name, value, description)
    +add_parameter(var_type: str, var_name: str, value: Any, description: str) None

    Add a new parameter. Will be prepended to the top of the models list

    -
    Parameters
    +
    Parameters:
      -
    • var_type – string, type of Modelica variable, Real, Integer, String, Modelica.Units.SI.Area, etc.

    • -
    • var_name – string, name of the variable. Note that this does not check for conflicts.

    • -
    • value – variant, value to set the variable name to.

    • -
    • description – string, description of the parameter

    • +
    • var_type (str) – type of Modelica variable, Real, Integer, String, Modelica.Units.SI.Area, etc.

    • +
    • var_name (str) – name of the variable. Note that this does not check for conflicts.

    • +
    • value (any) – value to set the variable name to.

    • +
    • description (str) – description of the parameter

    @@ -171,45 +178,77 @@

    InputParser
    -find_connect(port_a, port_b)
    +find_connect(port_a: str, port_b: str) Tuple[int | None, str | None]

    Find an existing connection that has port_a and/or port_b. If there are more than one, then it will only return the first.

    -
    Parameters
    +
    Parameters:
      -
    • port_a

    • -
    • port_b

    • +
    • port_a (str) – port a

    • +
    • port_b (str) – port b

    -
    Returns
    -

    +
    Raises:
    +

    Exception – could not find the connection

    +
    +
    Returns:
    +

    index and connection tuple

    +
    +
    Return type:
    +

    Tuple[Union[int, None], Union[str, None]]

    -find_model_object(obj_name)
    -

    Find a model object in the list of parsed objects -:param obj_name: string, name (including the instance) -:return: list, index and string of object

    +find_model_object(obj_name: str) Tuple[int | None, str | None] +

    Find a model object in the list of parsed objects

    +
    +
    Parameters:
    +

    obj_name (str) – name (including the instance)

    +
    +
    Returns:
    +

    index and string of object

    +
    +
    Return type:
    +

    Tuple[Union[int, None], Union[str, None]]

    +
    +
    +
    + +
    +
    +parse_mo()
    +

    Parse the input if it is a .mo file. This will populate the within, model, connections, and equations +along with various other tokens. This is a very basic parser and will not work for all cases.

    +

    # TODO: move over to token-based parsing and assessment of the files. +# TODO: strip all spacing and reconstruct on export

    +
    +
    Raises:
    +
      +
    • Exception – General exception Exception(“More than one ‘within’ lines found”)

    • +
    • Exception – _description_

    • +
    +
    +
    -reload()
    +reload()

    Reparse the data. This will remove any unsaved changes.

    -remove_connect_string(a, b)
    +remove_connect_string(a: str, b: str) None

    Remove a connection string that matches the a, b.

    -
    Parameters
    +
    Parameters:
      -
    • a – string, existing port a

    • -
    • b – string, existing port b

    • +
    • a (str) – existing port a

    • +
    • b (str) – existing port b

    @@ -217,30 +256,27 @@

    InputParser
    -remove_object(obj_name)
    +remove_object(obj_name: str) None

    Remove an object by a name. Can be any part of the object name.

    -
    Parameters
    -

    obj_name – string, object name to match

    -
    -
    Returns
    -

    +
    Parameters:
    +

    obj_name (str) – object name to match

    -replace_connect_string(a, b, new_a, new_b, replace_all=False)
    +replace_connect_string(a: str, b: str, new_a: str | None, new_b: str | None, replace_all: bool = False) None

    Replace content of the connect string with new_a and/or new_b

    -
    Parameters
    +
    Parameters:
      -
    • a – string, existing port a

    • -
    • b – string, existing port b

    • -
    • new_a – string, new port (or none)

    • -
    • new_b – string, new port b (or none

    • -
    • replace_all – boolean, allow replacemnt of all strings

    • +
    • a (str) – existing port a

    • +
    • b (str) – existing port b

    • +
    • new_a (str) – new port (or none)

    • +
    • new_b (str) – new port b (or none)

    • +
    • replace_all (bool, optional) – allow replacement of all strings. Defaults to False.

    @@ -248,17 +284,17 @@

    InputParser
    -replace_model_string(model_name, model_instance, old_string, new_string)
    +replace_model_string(model_name: str, model_instance: str, old_string: str, new_string: str)

    Go through the models and find the model_name with a model_instance and change the value in the field to the new_value. This will replace the entire value of the model field.

    This will not work with arrays or lists (e.g., {…}, […])

    -
    Parameters
    +
    Parameters:
      -
    • model_name – string, name of the model

    • -
    • model_instance – string, instance of the model

    • -
    • old_string – string, name of the old string to replace

    • -
    • new_string – string, the new string

    • +
    • model_name (str) – name of the model

    • +
    • model_instance (str) – instance of the model

    • +
    • old_string (str) – name of the old string to replace

    • +
    • new_string (str) – new string

    @@ -266,47 +302,42 @@

    InputParser
    -replace_within_string(new_string)
    +replace_within_string(new_string: str) None

    Replacement of the path portion of the within string

    -
    Parameters
    -

    new_string – string, what to replace the existing within string with.

    +
    Parameters:
    +

    new_string (str) – what to replace the existing within string with.

    -save()
    +save() None

    Save the resulting file to the same file from which it was initialized

    -
    -
    Returns
    -

    -
    -
    -save_as(new_filename)
    +save_as(new_filename: str | Path) None

    Save the resulting file with a new filename

    -
    Parameters
    -

    new_filename

    -
    -
    Returns
    -

    +
    Parameters:
    +

    new_filename (Union[str, Path]) – name of the new file to save as

    -serialize()
    +serialize() str

    Serialize the modelica object to a string with line feeds

    -
    Returns
    -

    string

    +
    Returns:
    +

    string representation of the data

    +
    +
    Return type:
    +

    str

    @@ -322,6 +353,34 @@

    InputParser

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.modelica.input_parser.html b/_autosummary/geojson_modelica_translator.modelica.input_parser.html index ab2236eab..97e3c3aed 100644 --- a/_autosummary/geojson_modelica_translator.modelica.input_parser.html +++ b/_autosummary/geojson_modelica_translator.modelica.input_parser.html @@ -1,21 +1,18 @@ - - + - + - input_parser — GeoJSON Modelica Translator v0.5.0 documentation - - - + input_parser — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + @@ -37,7 +34,7 @@

    Navigation

  • previous |
  • - + @@ -51,20 +48,13 @@

    Navigation

    -

    input_parser

    +

    input_parser

    Classes

    __init__(modelica_filename)

    Initialize the class with the modelica file to parse

    add_connect(a, b, annotation)

    Add a new connection of port a to port b.

    find_model_object(obj_name)

    Find a model object in the list of parsed objects :param obj_name: string, name (including the instance) :return: list, index and string of object

    Find a model object in the list of parsed objects

    init_vars()

    parse_mo()

    parse_mo()

    Parse the input if it is a .mo file.

    reload()

    Reparse the data.

    ---- - - -

    InputParser(modelica_filename)

    Class to read in Modelica files (.mo) and provide basic operations.

    PackageParser([path])

    Class to read and modify the package.mo and the package.order file

    @@ -122,7 +112,7 @@

    Navigation

  • previous |
  • - + @@ -130,8 +120,8 @@

    Navigation

    \ No newline at end of file diff --git a/_autosummary/geojson_modelica_translator.modelica.lib.html b/_autosummary/geojson_modelica_translator.modelica.lib.html index 722e18d6d..3ea9b199e 100644 --- a/_autosummary/geojson_modelica_translator.modelica.lib.html +++ b/_autosummary/geojson_modelica_translator.modelica.lib.html @@ -1,26 +1,23 @@ - - + - + - lib — GeoJSON Modelica Translator v0.5.0 documentation - - - + lib — GeoJSON Modelica Translator v0.6.0-rc2 documentation + + + - - - - - + + + - +