feat: DNA initialize math-gymnasium project

- Introduced configuration for Dockerized-NorLab project (DNA) setup.
- Added PyTorch and CUDA verification scripts for dependency checks.
- Included hyperparameter optimization pipelines via Hydra and Optuna.
- Implemented CI test scripts for streamlined pytest execution.
- Configured README documentation for project structure guidance.

Author: RedLeader962

.dockerignore

@@ -0,0 +1,57 @@
+# =================================================================================================
+#
+#   Specify files/directories to be ignored by the Dockerfile COPY/ADD clause
+#   Note: content from "volumes" will still be accessible inside the container
+#
+#   Syntax:
+#       "*"     match any number of characters
+#       "?"     match one character
+#       "!"     prevent ignore
+#       "**"    match any number of directories
+#
+#   References: https://docs.docker.com/build/building/context/#dockerignore-files
+#
+# =================================================================================================
+
+# ====Dockerized-NorLab(required)==================================================================
+!**/.dockerized_norlab/
+!**/version.txt
+!**/.git
+
+# ====Dockerized-NorLab(recommended)===============================================================
+**/external_data/
+**/artifact/
+**/slurm_jobs_logs/*.log
+
+# ====General======================================================================================
+# ....Repository related...........................................................................
+.github
+.releaserc.json
+CHANGELOG.md
+commit_msg_reference.md
+visual/
+
+# ....Graphic/image related........................................................................
+**/*.svg
+**/*.svgz
+**/*.drawio
+**/drawio/
+
+# ....Text related.................................................................................
+**/*.pdf
+
+# ....Python related...............................................................................
+**/.pytest_cache
+**/.benchmarks
+**/__pycache__
+**/*.pyc
+
+# ....Jetbrains....................................................................................
+/.run/
+/.idea/
+
+# ....Log..........................................................................................
+**/*.out
+
+# ....General......................................................................................
+**/.DS_Store

.dockerized_norlab/.env.math-gymnasium

@@ -0,0 +1,6 @@
+# =================================================================================================
+# Dockerized-NorLab project application (DNA) super project configuration meta information(s).
+#
+# Reference: https://github.com/norlab-ulaval/dockerized-norlab-project
+# =================================================================================================
+DNA_CONFIG_SCHEME_VERSION=1

.dockerized_norlab/README.md

@@ -0,0 +1,29 @@
+# Dockerized-NorLab project application (DNA)
+
+https://github.com/norlab-ulaval/dockerized-norlab-project.git
+
+
+## Getting started ... fast
+Check [DNA documentation](https://github.com/norlab-ulaval/dockerized-norlab-project?tab=readme-ov-file#documentation) for details
+
+1. Setup/validate `.dockerized_norlab/configuration/` files: 
+   - Setup dotenv files: `.env`, `.env.dna` and `.env.local`;
+   - Customize files in `project_requirements/`;
+   - Customize files in `project_entrypoints/`. Add
+      project-specific container runtime logic;
+   - Customize `Dockerfile` to fit your need. It should work out of the box for most use cases;
+   - Check `.dockerized_norlab/configuration/README.md` for more details.
+2. From your project `root`, execute the following
+   ```shell
+   dna help 
+   
+   # Build your DN-project containers 
+   dna build 
+   
+   # Start your DN-project containers 
+   dna up
+   
+   # Have fun
+   # When your done, execute 
+   dna down
+   ```

.dockerized_norlab/configuration/.env

@@ -0,0 +1,47 @@
+# =================================================================================================
+# Set run time environment variable.
+#
+# Notes:
+#   - DNA dotenv file loading precedence:
+#       1. .env.dna
+#       2. .env
+#       3. .env.local
+#       4. .env.dna-internal (DNA repository)
+#
+# =================================================================================================
+
+# ....GPU..........................................................................................
+# Reference: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/docker-specialized.html
+
+# Nvidia visible devices options: "all", "none", "void", gpu UUID e.g., "GPU-fef8089b or gpu indexes list e.g., "0,1,2"
+#NVIDIA_VISIBLE_DEVICES=all
+
+# Nvidia driver capabilities options: "all" or a list of comma-separated driver's name e.g., "compute,utility"
+# Available driver: compute, compat32, graphics, utility, video or display
+#NVIDIA_DRIVER_CAPABILITIES=all
+
+# ....ROS..........................................................................................
+#ROS_DOMAIN_ID=1
+
+# Enable ROS2 log collouring
+#RCUTILS_COLORIZED_OUTPUT=1
+
+# rmw implementation options: rmw_fastrtps_cpp, rmw_cyclonedds_cpp
+#RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
+
+#DDS_NETWORK_INTERFACE=eth0
+#CYCLONEDDS_URI="<CycloneDDS><Domain><General><NetworkInterface>${DDS_NETWORK_INTERFACE:?err}</></></></>"
+# Fix for warning "ros2: using network interface eth0 (udp/169.254.205.89) selected
+#  arbitrarily from: eth0, wlan0, docker0".
+# Solution ref: https://answers.ros.org/question/375360/multiple-network-interfaces-with-rmw_cyclonedds_cpp/
+
+# ....Python.......................................................................................
+#PYTHONUNBUFFERED=1
+#PYCHARM_DEBUG=1
+#PYTEST_DEBUG=1
+
+# ....Hydra........................................................................................
+#HYDRA_FULL_ERROR=1
+
+# Set omegaconf full error backtrace
+#OC_CAUSE=1

.dockerized_norlab/configuration/.env.dna

@@ -0,0 +1,116 @@
+# =================================================================================================
+# Set Dockerized-NorLab project application (DNA) environment variable.
+#
+# Notes:
+#   - This dotenv file is use both at buildtime and runtime
+#   - DNA dotenv file loading precedence:
+#       1. .env.dna
+#       2. .env
+#       3. .env.local
+#       4. .env.dna-internal (DNA repository)
+#
+# =================================================================================================
+
+# ....Console option...............................................................................
+# Un-comment to override
+
+#DN_ENTRYPOINT_TRACE_EXECUTION=true
+#DN_SHOW_DEBUG_INFO=true
+
+# DNA container prompt style
+# Requirement:
+#   - Ubuntu: "$ sudo apt-get install fonts-powerline" and select patched font in terminal, example "Ubuntu mono"
+#   - MacOs: Any font from list "$ brew search nerd-font" -> "$ brew install font-FONT-NAME-nerd-font"
+#            Example "$ brew install font-jetbrains-mono-nerd-font" and select patched font in terminal, "JetBrainsMon Nerd Font Mono"
+#            Check preview at https://www.nerdfonts.com/font-downloads
+#DN_ACTIVATE_POWERLINE_PROMT=true
+
+# ....Repository config............................................................................
+DN_PROJECT_GIT_REMOTE_URL=https://github.com/norlab-ulaval/math-gymnasium.git
+
+# ....Docker config................................................................................
+DN_CONTAINER_NAME="IamDNA_mg"
+DN_PROJECT_ALIAS_PREFIX="mg"
+
+# Set the project core base image
+# Un-comment to override (default to 'dockerized-norlab-dependencies-full')
+#DN_PROJECT_BASE_IMG=dockerized-norlab-dependencies-full
+
+# Set the Dockerized-NorLab base image version
+# Use one of the following:
+# - 'latest' is the latest push to the repository default branch
+# - 'bleeding' is the latest push to the repository dev branch (i.e. bleeding-edge)
+# - you can use a specific release version tag number, e.g., 'v0.7.0'
+# - un-comment to override (default to 'latest')
+#DN_VERSION=bleeding
+
+# This the Docker hub from where your project images will be pushed to and pulled from.
+# Un-comment to override (default to norlabulaval)
+#DN_PROJECT_HUB=norlabulaval
+
+# ....Development config...........................................................................
+# Special user with dedicated shell configuration tailormade for ROS2 remote development
+#DN_SSH_SERVER_USER="${DN_PROJECT_ALIAS_PREFIX}-non-interactive-ros2"
+
+# Port assignement
+#DN_SSH_SERVER_PORT=2222
+#DN_GDB_SERVER_PORT=7777
+
+# Set the ssh daemon in no detach mode for server operation monitoring
+#DN_SSH_DAEMON_NO_DETACH=true
+
+# ....deploy config................................................................................
+# Path to the src code that will be cloned into the DN project-deploy image
+# - Un-comment to override (default to repository root)
+#DN_PROJECT_DEPLOY_SRC_PATH="${SUPER_PROJECT_ROOT:?err}/arbitrary/path"
+
+# Branch checkout for the project-deploy image
+# - Options: 'main', 'dev', '<feature-branch>' or tag version (ie 'v*.*.*')
+# - Un-comment to override (default to 'main')
+# - Automaticaly use the current checkout branch otherwise
+#DN_PROJECT_DEPLOY_REPO_BRANCH=dev
+
+# ====Dockerized-NorLab============================================================================
+
+# ....Tag..........................................................................................
+# The Dockerized-NorLab base image tag is generated by DNA internaly using various environment variables either set by the user or set by DNA.
+# The gerated base image tag and base image name follow this patern:
+#
+#   <dn-project-hub>/<dn-project-base-img>:DN-<dn-version>-<tag-package>-<tag-os-version>
+#
+# Example:
+#   norlabulaval/dockerized-norlab-dependencies-full:DN-bleeding-galactic-desktop-l4t-pytorch-r35.4.1
+#
+# See https://hub.docker.com/repositories/norlabulaval for available base images.
+
+# The Dockerized-NorLab base image tag package name
+# Un-comment to override
+#TAG_PACKAGE=humble-base-l4t-pytorch
+
+# The Linux-for-Tegra (Jetson OS) container tag version
+# Un-comment to override
+#TAG_OS_VERSION=r36.4.0
+
+# ....Main config..................................................................................
+# Set the Dockerized-NorLab docker image hub where to pull DN_PROJECT_BASE_IMG from
+# Un-comment to override (default to 'norlabulaval')
+#DN_HUB=norlabulaval
+
+# Set the Dockerized-NorLab repository branch for container internal tools
+# Accept 'main', 'dev', '<feature-branch-name>' or tag version 'v*.*.*'
+# Un-comment to override (default to 'main')
+#DN_GIT_BRANCH=dev
+
+# ====Docker CLI/config/internal===================================================================
+# Docker context global overide
+# Un-comment to set in DNA
+#DOCKER_CONTEXT=desktop-linux
+
+# Docker builder global overide.
+# Un-comment to set in DNA
+#BUILDX_BUILDER=desktop-linux
+# Note: DNA 'execute_compose.bash' automaticaly select the native builder if BUILDX_BUILDER is not set.
+
+# For debuging docker build localy, use `docker build --progress=plain --no-cache` flags instead
+# Un-comment to set in DNA for debugging dockerfile
+#BUILDKIT_PROGRESS=plain

.dockerized_norlab/configuration/.env.local

@@ -0,0 +1,14 @@
+# =================================================================================================
+# Set host bound environment variable.
+#
+# Notes:
+#   - This file is added to '.gitignore' by default so any modification made here will only affect
+#     the current host.
+#   - This dotenv file is loaded last so it can be use as an environment variables override file.
+#     DNA dotenv file loading precedence:
+#       1. .env.dna
+#       2. .env
+#       3. .env.local
+#       4. .env.dna-internal (DNA repository)
+#
+# =================================================================================================

.dockerized_norlab/configuration/Dockerfile

@@ -0,0 +1,60 @@
+# =================================================================================================
+#
+#   👍  You can change the code in this file to take advantage of the Docker cache layer mechanism
+#       and the Docker multi-stage build feature.
+#
+# =================================================================================================
+ARG BASE_IMAGE
+ARG BASE_IMAGE_TAG
+FROM ${BASE_IMAGE:?err}:${BASE_IMAGE_TAG:?err} AS user-project-custom-steps
+
+ARG TARGETPLATFORM
+ARG BUILDPLATFORM
+WORKDIR ${DN_PROJECT_PATH:?'environment variable is not set'}
+
+# ADD YOUR CODE HERE
+# ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
+# ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
+
+# Example
+RUN <<EOF
+    # ....Examples.................................................................................
+    {
+        echo "...Sanity check............................" && \
+        echo "python version: $(n2st::which_python3_version)" && \
+        python -c "import pytest" && \
+        echo "..........................................." ;
+    } || n2st::print_msg_error_and_exit "Failed sanity check!"
+EOF
+
+RUN <<EOF
+    # ....Examples with cuda.......................................................................
+    # Note: Assuming the base image is nvidia cuda enable and has pycuda and pytorch installed
+    if pip -qq show torch; then
+        {
+          echo "..........................................." && \
+          echo "Sanity check" && \
+          python -c "import torch" && \
+          echo "..........................................." ;
+        } || n2st::print_msg_error_and_exit "Failed torch sanity check!"
+        (
+          echo
+          echo "alias dn-pytorch-cuda-check='python3 /ros2_ws/src/dockerized-norlab-project-mock/src/dna_example/try_pytorch.py'"
+          echo
+        ) >> /dockerized-norlab/dockerized-norlab-images/container-tools/dn_bash_alias.bash
+    fi
+
+    if pip -qq show pycuda; then
+        {
+          echo "..........................................." && \
+          echo "Sanity check" && \
+          python -c "import pycuda" && \
+          echo "..........................................." ;
+        } || n2st::print_msg_error_and_exit "Failed pycuda sanity check!"
+        (
+          echo
+          echo "alias dn-pycuda-check='python3 /ros2_ws/src/dockerized-norlab-project-mock/src/dna_example/try_pycuda.py'"
+          echo
+        ) >> /dockerized-norlab/dockerized-norlab-images/container-tools/dn_bash_alias.bash
+    fi
+EOF

.dockerized_norlab/configuration/README.md

@@ -0,0 +1,13 @@
+
+#### DNA dotenv file loading precedence:
+
+1. .env.dna
+2. .env
+3. .env.local
+4. .env.dna-internal (DNA repo)
+
+#### References
+- [Docker-Compose environment variables precedence](https://docs.docker.com/compose/how-tos/environment-variables/envvars-precedence/)
+- Docker predefined environment variables
+  - [Docker](https://docs.docker.com/reference/cli/docker/)
+  - [Docker-Compose](https://docs.docker.com/compose/how-tos/environment-variables/envvars/)

.dockerized_norlab/configuration/project_entrypoints/dn_entrypoint.global.attach.callback.bash

@@ -0,0 +1,23 @@
+#!/bin/bash
+# =================================================================================================
+# Dockerized-NorLab container runtime entrypoint callback.
+# Is executed each time a shell is attach to a project-develop or project-deploy container.
+#
+# Usage:
+#   Add project wide logic that need to be executed by each shell.
+#
+# Globals:
+#   Read/write all environment variable exposed in DN at runtime
+#
+# =================================================================================================
+
+# ....DNA-project internal logic...................................................................
+source /dna-lib-container-tools/project_entrypoints/entrypoint_helper.global.common.bash || exit 1
+
+# ====DNA-project user defined logic===============================================================
+# Add your code here
+
+# ....Examples: source ROS2 environment variables..................................................
+#dn::source_ros2_underlay_only
+#dn::source_ros2_overlay_only
+dn::source_ros2