Skip to content

Commit

Permalink
initial changes to text
Browse files Browse the repository at this point in the history
  • Loading branch information
vtnate committed Dec 9, 2024
1 parent caff23f commit 8e61e5f
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 19 deletions.
18 changes: 1 addition & 17 deletions docs/developer_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Each block type can "connect" (note this "connect" does not refer to Modelica's

Each block type has a corresponding directory inside of :code:`geojson_modelica_translator/model_connectors`, which contains its different model types (e.g. for Loads it contains the Time Series model and others).

Because models are different, even within a block type (e.g. different properties and maybe even ports), the GMT uses the concept of couplings for connecting models. Couplings define how two *specific* models connect in modelica.
Because models are different, even within a block type (e.g., different properties and maybe even ports), the GMT uses the concept of couplings for connecting models. Couplings define how two *specific* models connect in modelica.
For example, a coupling could define how the time series load actually connects to the heating indirect ETS.

-- As an aside, if the GMT reached a point where all models within a block type implemented the same interface then couplings would not be necessary.
Expand Down Expand Up @@ -99,22 +99,6 @@ To run pre-commit against the files without calling git commit, then run the fol
pre-commit run --all-files
Managed Tasks
*************

Updating Schemas
^^^^^^^^^^^^^^^^

There is managed task to automatically pull updated GeoJSON schemas from the :code:`urbanopt-geojson-gem` GitHub
project. A developer can run this command by calling

.. code-block:: bash
poetry run update_schemas
The developer should run the test suite after updating the schemas to ensure that nothing appears to have broken. Note that the tests do not cover all of the properties and should not be used as proof that everything works with the updated schemas.


Adding New Models
-----------------

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Therefore, this Getting Started guide is broken up into three major setup steps.
GMT Installation
----------------

You must have PIP and Python 3.9 or later installed (run :code:`python --version` to see what version you're using). After installing Python and PIP run the following in a terminal:
You must have PIP and Python 3.10 or later installed (run :code:`python --version` to see what version you're using). After installing Python and PIP run the following in a terminal:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Overview
========

The GeoJSON Modelica Translator (GMT) is a one-way trip from GeoJSON in combination with a well-defined instance of the system parameters schema to a Modelica package with multiple buildings loads, energy transfer stations, distribution networks, and central plants. The project will eventually allow multiple paths to build up different district heating and cooling system topologies; however, the initial implementation is limited to 1GDH and 4GDHC.
The GeoJSON Modelica Translator (GMT) is a one-way trip from GeoJSON in combination with a well-defined instance of the system parameters schema to a Modelica package with multiple buildings loads, energy transfer stations, distribution networks, and central plants. The project will eventually allow multiple paths to build up different district heating and cooling system topologies; however, the initial implementation is limited to 4GDHC and 5GDHC.

The project is motivated by the need to easily evaluate district energy systems. The goal is to eventually cover the various generations of heating and cooling systems as shown in the figure below. The need to move towards 5GDHC systems results in higher efficiencies and greater access to additional waste-heat sources.

Expand Down

0 comments on commit 8e61e5f

Please sign in to comment.