Check docker (#16)

andoludo · Nov 3, 2024 · 65324d6 · 65324d6
2 parents 4bfd6db + 7b321a7
commit 65324d6
Show file tree

Hide file tree

Showing 84 changed files with 350 additions and 68 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+*       @andoludo
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -18,11 +18,7 @@ jobs:
           python-version: '3.10'
 
       - name: Install Poetry
-        run: |
-          curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python3
-          cd /usr/local/bin
-          ln -s /opt/poetry/bin/poetry
-          poetry config virtualenvs.create false
+        uses: snok/install-poetry@v1
 
       - name: Install dependencies
         run: |

diff --git a/.github/workflows/tests-runner.yaml b/.github/workflows/tests-runner.yaml
@@ -18,11 +18,7 @@ jobs:
         python-version: "3.10"
 
     - name: Install Poetry
-      run: |
-        curl -sSL https://install.python-poetry.org | POETRY_HOME=/opt/poetry python3
-        cd /usr/local/bin
-        ln -s /opt/poetry/bin/poetry
-        poetry config virtualenvs.create false
+      uses: snok/install-poetry@v1
 
     - name: Install dependencies
       run: poetry install

diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -1,24 +1,30 @@
 # Installation
 ## Python package
 
-Trano is a Python package that can be easily installed via pip.
+
+!!! warning
+    Trano requires python 3.9 or higher and docker to be installed on the system.
+
+
+Trano is a Python package that can be installed via pip.
 
 
 ```bash
 pip install trano
 ```
-
+            
 
 Trano can also be utilized with Poetry.
 
 
 ```bash
 poetry add trano
 ```
+            
 
-
-The Python package enables the generation of Modelica models from YAML configuration input. To simulate the model, ensure that Docker is installed on your system.
+The Python package enables the generation of a Modelica model from YAML configuration input. To simulate the model, Docker must be installed on the system.
 
 ## Docker
 
-To simulate the Modelica model, you need to install Docker on your system. You can find installation instructions on the [official Docker website](https://docs.docker.com/engine/install/).
+To simulate the Modelica model, you must install Docker on your system. You can find installation instructions on the [official Docker website](https://docs.docker.com/engine/install/).
+
diff --git a/docs_src/getting_started/installation.py b/docs_src/getting_started/installation.py
@@ -1,12 +1,18 @@
 from pathlib import Path
 
-from docs_src.utils import CleanedText, DisplayObject, TitleText, Tutorial
+from docs_src.utils import CleanedText, DisplayObject, TitleText, Tutorial, Text
 
 INSTALLATIONS = [
     Tutorial(
         title="Installation",
         contents=[
             TitleText(content="""Python package"""),
+            Text(
+                content="""
+!!! warning
+    Trano requires python 3.9 or higher and docker to be installed on the system.
+            """
+            ),
             CleanedText(
                 content="""Trano is a python package that can be installed using pip."""
             ),

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,10 +33,7 @@ matplotlib = "^3.8.2"
 uuid = "^1.30"
 docker = "^7.0.0"
 jinja2 = "^3.1.2"
-pytest = "^7.4.3"
 pyvis = "^0.3.2"
-scipy = "^1.13.1"
-mat4py = "^0.6.0"
 pandas = "^2.2.2"
 buildingspy = "^5.1.0"
 plotly = "^5.22.0"
@@ -47,10 +44,12 @@ linkml = "^1.8.1"
 cruft = "^2.15.0"
 rdflib = "^7.0.0"
 pyyaml-include = "^2.1"
+typer = "^0.12.5"
 
+[tool.poetry.scripts]
+trano = "trano.main:app"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.4.3"
 mypy = "^1.8.0"
 nox = "^2023.4.22"
 ruff = "^0.3.0"
@@ -65,7 +64,7 @@ types-pyyaml = "^6.0.12.20240808"
 isort = "^5.13.2"
 jsf = "^0.11.2"
 black = "^24.10.0"
-
+pytest = "^7.4.3"
 
 
 [tool.poetry.group.docs.dependencies]

diff --git a/trano/__init__.py b/trano/__init__.py
diff --git a/trano/data/default.yaml b/trano/data/default.yaml
diff --git a/trano/data/include.py b/trano/data/include.py
diff --git a/trano/data_models/__init__.py b/trano/data_models/__init__.py
diff --git a/trano/data_models/conversion.py b/trano/data_models/conversion.py
diff --git a/trano/data_models/converter.py b/trano/data_models/converter.py
diff --git a/trano/data_models/parameters.yaml b/trano/data_models/parameters.yaml
diff --git a/trano/data_models/trano.yaml b/trano/data_models/trano.yaml
diff --git a/trano/data_models/trano_final.yaml b/trano/data_models/trano_final.yaml
diff --git a/trano/elements/__init__.py b/trano/elements/__init__.py
diff --git a/trano/elements/base.py b/trano/elements/base.py
diff --git a/trano/elements/boundary.py b/trano/elements/boundary.py
diff --git a/trano/elements/bus.py b/trano/elements/bus.py
diff --git a/trano/elements/components.py b/trano/elements/components.py
diff --git a/trano/elements/connection.py b/trano/elements/connection.py
diff --git a/trano/elements/construction.py b/trano/elements/construction.py
diff --git a/trano/elements/control.py b/trano/elements/control.py
diff --git a/trano/elements/controller_bus.py b/trano/elements/controller_bus.py
diff --git a/trano/elements/element.yaml b/trano/elements/element.yaml
diff --git a/trano/elements/envelope.py b/trano/elements/envelope.py
diff --git a/trano/elements/figure.py b/trano/elements/figure.py
diff --git a/trano/elements/inputs.py b/trano/elements/inputs.py
diff --git a/trano/elements/models/ahu_control.yaml b/trano/elements/models/ahu_control.yaml
diff --git a/trano/elements/models/air_handling_unit.yaml b/trano/elements/models/air_handling_unit.yaml
diff --git a/trano/elements/models/boiler.yaml b/trano/elements/models/boiler.yaml
diff --git a/trano/elements/models/boiler_control.yaml b/trano/elements/models/boiler_control.yaml
diff --git a/trano/elements/models/boundary.yaml b/trano/elements/models/boundary.yaml
diff --git a/trano/elements/models/collector_control.yaml b/trano/elements/models/collector_control.yaml
diff --git a/trano/elements/models/data_bus.yaml b/trano/elements/models/data_bus.yaml
diff --git a/trano/elements/models/duct.yaml b/trano/elements/models/duct.yaml
diff --git a/trano/elements/models/emission_control.yaml b/trano/elements/models/emission_control.yaml
diff --git a/trano/elements/models/external_wall.yaml b/trano/elements/models/external_wall.yaml
diff --git a/trano/elements/models/floor_on_ground.yaml b/trano/elements/models/floor_on_ground.yaml
diff --git a/trano/elements/models/internal_element.yaml b/trano/elements/models/internal_element.yaml
diff --git a/trano/elements/models/merged_windows.yaml b/trano/elements/models/merged_windows.yaml
diff --git a/trano/elements/models/occupancy.yaml b/trano/elements/models/occupancy.yaml
diff --git a/trano/elements/models/pump.yaml b/trano/elements/models/pump.yaml
diff --git a/trano/elements/models/radiator.yaml b/trano/elements/models/radiator.yaml
diff --git a/trano/elements/models/space.yaml b/trano/elements/models/space.yaml
diff --git a/trano/elements/models/split_valve.yaml b/trano/elements/models/split_valve.yaml
diff --git a/trano/elements/models/temperature_sensor.yaml b/trano/elements/models/temperature_sensor.yaml
diff --git a/trano/elements/models/three_way_valve.yaml b/trano/elements/models/three_way_valve.yaml
diff --git a/trano/elements/models/three_way_valve_control.yaml b/trano/elements/models/three_way_valve_control.yaml
diff --git a/trano/elements/models/valve.yaml b/trano/elements/models/valve.yaml
diff --git a/trano/elements/models/vav.yaml b/trano/elements/models/vav.yaml
diff --git a/trano/elements/models/vav_control.yaml b/trano/elements/models/vav_control.yaml
diff --git a/trano/elements/models/weather.yaml b/trano/elements/models/weather.yaml
diff --git a/trano/elements/models/window.yaml b/trano/elements/models/window.yaml
diff --git a/trano/elements/parameters.py b/trano/elements/parameters.py
diff --git a/trano/elements/space.py b/trano/elements/space.py
diff --git a/trano/elements/system.py b/trano/elements/system.py
diff --git a/trano/elements/types.py b/trano/elements/types.py
diff --git a/trano/elements/utils.py b/trano/elements/utils.py
diff --git a/trano/exceptions.py b/trano/exceptions.py
@@ -7,3 +7,9 @@ class ControllerBusPortError(Exception):
 
 
 class IncompatiblePortsError(Exception): ...
+
+
+class DockerNotInstalledError(Exception): ...
+
+
+class DockerClientError(Exception): ...
diff --git a/trano/library/library.py b/trano/library/library.py
diff --git a/trano/library/library.yaml b/trano/library/library.yaml
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,9 @@ class ControllerBusPortError(Exception):


		class IncompatiblePortsError(Exception): ...


		class DockerNotInstalledError(Exception): ...


		class DockerClientError(Exception): ...