Mac OS Setup Instructions

.github/workflows/build.yaml

@@ -14,32 +14,49 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest  # Use an Ubuntu runner for the job
-
     strategy:
       matrix:
-        python-version: [3.10.12, 3.10.15, 3.11]  # Python versions to test
+        # there is no 3.10.15 on mac
+        # see: https://raw.githubusercontent.com/actions/python-versions/main/versions-manifest.json
+        os: [ubuntu-latest]
+        python-version: ['3.10.15', '3.11']
+
+        include:
+          - os: macos-13 # intel-based
+            python-version: '3.11'
+
+          - os: macos-latest # arm-based
+            python-version: '3.11'
+
+    runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v4  # Checks out the repository's code
+      uses: actions/checkout@v4
 
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: ${{ matrix.python-version }}  # Use Python version from the matrix
+        python-version: ${{ matrix.python-version }}
 
-    - name: Install system dependencies
+    - name: Install system dependencies (on Linux)
+      if: runner.os == 'Linux'
       run: |
         sudo apt update
-        sudo apt install -y protobuf-compiler ffmpeg  # Install both protobuf and ffmpeg in one step
+        sudo apt install -y protobuf-compiler ffmpeg
+
+    - name: Install system dependencies (on Mac)
+      if: runner.os == 'macOS'
+      run: |
+        brew update
+        brew install protobuf@21 ffmpeg
 
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
         python -m venv .venv
         source .venv/bin/activate
-        pip install poetry
+        pip install poetry==2.1.2
         poetry install --with dev
 
     - name: Run the Python formatter

.pre-commit-config.yaml

@@ -9,6 +9,7 @@ repos:
       language: system
       types: [file, python]
       files: '^smart_control/'
+      exclude: '^smart_control/Dockerfile'
 
     - id: isort
       name: isort

.vscode/settings.json

@@ -24,4 +24,8 @@
     // using pyink instead of black:
     ".venv/bin/pyink"
   ],
+  "[dockerfile]": {
+    "editor.formatOnSave": false,
+    "editor.defaultFormatter": null
+  }
 }

Dockerfile

@@ -58,7 +58,7 @@ RUN /opt/venv/bin/pip install \
 
 # Install dependencies from the temporary location
 RUN cd /tmp/sbsim && \
-    poetry lock --no-update && \
+    poetry lock && \
     poetry install --no-root
 
 # Build .proto files

Makefile

@@ -1,10 +1,7 @@
 # NOTE: you have to use tabs (not spaces) to define commands in the Makefile
 
 # these are commands to be run, not files to be created:
-.PHONY: activate docs docs-build docs-quiet mdformat pyink isort pylint lint test
-
-# variable pointing to the virtual environment executable files:
-VENV_BIN := .venv/bin
+.PHONY: venv-activate docs docs-build docs-quiet mdformat pyink isort pylint lint test
 
 #
 # ENVIRONMENT
@@ -13,24 +10,24 @@ VENV_BIN := .venv/bin
 # https://stackoverflow.com/questions/33839018/activate-virtualenv-in-makefile
 # this command uses a different shell, so you must run it manually:
 # bash -c "source .venv/bin/activate"
-activate:
+venv-activate:
 	@echo "Run this command to activate the environment: source .venv/bin/activate"
 
 #
 # LINTING AND FORMATTING
 #
 
 mdformat:
-	${VENV_BIN}/mdformat README.md docs/
+	poetry run mdformat README.md docs/*
 
 pyink:
-	${VENV_BIN}/pyink .
+	poetry run pyink .
 
 isort:
-	$(VENV_BIN)/isort .
+	poetry run isort .
 
 pylint:
-	$(VENV_BIN)/pylint --rcfile=.pylintrc --ignore=proto smart_control
+	poetry run pylint --rcfile=.pylintrc --ignore=proto smart_control
 
 # mega-command for running all formatters:
 format: mdformat pyink isort pylint
@@ -40,17 +37,17 @@ format: mdformat pyink isort pylint
 #
 
 test:
-	$(VENV_BIN)/pytest --disable-pytest-warnings
+	poetry run pytest --disable-pytest-warnings
 
 #
 # DOCS
 #
 
 docs:
-	$(VENV_BIN)/mkdocs serve
+	poetry run mkdocs serve
 
 docs-quiet:
-	${VENV_BIN}/mkdocs serve --quiet
+	poetry run mkdocs serve --quiet
 
 docs-build:
-	$(VENV_BIN)/mkdocs build
+	poetry run mkdocs build

docs/api/config.md

@@ -1,3 +1,4 @@
 # Configuration
 
-The project uses Gin ("*.gin") configuration files to manage simulation settings, reward function parameters, and environment configurations.
+The project uses Gin ("\*.gin") configuration files to manage simulation
+settings, reward function parameters, and environment configurations.