[ci] add the option to install the project in a 'bare metal' installation, see README.md for instructions

Dockerfile

@@ -162,7 +162,8 @@ COPY samgis_lisa_on_cuda ${LAMBDA_TASK_ROOT}/samgis_lisa_on_cuda
 COPY wrappers ${LAMBDA_TASK_ROOT}/wrappers
 COPY scripts ${LAMBDA_TASK_ROOT}/scripts
 RUN chmod +x ${LAMBDA_TASK_ROOT}/scripts/entrypoint.sh
-RUN ls -l ${LAMBDA_TASK_ROOT}/scripts/entrypoint.sh
+RUN chown +x  ${LAMBDA_TASK_ROOT}/scripts/docker_entrypoint.sh
+RUN ls -l ${LAMBDA_TASK_ROOT}/scripts/entrypoint.sh ${LAMBDA_TASK_ROOT}/scripts/docker_entrypoint.sh
 
 RUN ls -l /usr/bin/which
 RUN /usr/bin/which python
@@ -193,4 +194,4 @@ RUN ls -l ${FASTAPI_STATIC}/ || true
 RUN ls -l ${FASTAPI_STATIC}/dist || true
 RUN ls -l ${FASTAPI_STATIC}/node_modules || true
 
-CMD ["/var/task/scripts/entrypoint.sh"]
+CMD ["/var/task/scripts/docker_entrypoint.sh"]

README.md

@@ -9,6 +9,7 @@ license: mit
 ---
 
 ## Segment Anything models
+
 It's possible to prepare the model files using https://github.com/vietanhdev/samexporter/ or using the ones 
 from https://huggingface.co/aletrn/sam-quantized (copy them within the folder `/machine_learning_models`).
 
@@ -90,8 +91,9 @@ cd docs && make clean html && cd ../
 ```
 
 The static documentation it's now ready at the path `docs/_build/html/index.html`.
- 
+
 To create a work in progress openapi json or yaml file use
+
 - `extract-openapi-fastapi.py`
 - `extract-openapi-lambda.py` (useful to export the json schema request and response from lambda app api)
 
@@ -113,3 +115,24 @@ it's possible to dynamically create a new support folder adding it to a json str
 ```
 
 The python script create_folders_and_variables_if_not_exists.py will read this env variable, removing any files that exists with these pathnames and assert the correct creation of all the folders. Also these folders must exist as env variables, so the script assert that an env variable exists with its path.
+
+It's possible to use the project in a bare metal installation (not within a docker container). To do this
+
+- download this project
+- prepare a virtualenv and install the python dependencies
+- install nodejs LTS
+- create a .env_source file (in this case `HOME=/home/jovyan`)
+
+  ```bash
+  export FOLDER_MAP='{"WORKDIR":"/home/jovyan/workspace/samgis-lisa-on-cuda","XDG_CACHE_HOME":"/home/jovyan/.cache","PROJECT_ROOT_FOLDER":"/home/jovyan/","MPLCONFIGDIR":"/home/jovyan/.cache/matplotlib","TRANSFORMERS_CACHE":"/home/jovyan/.cache/transformers","PYTORCH_KERNEL_CACHE_PATH":"/home/jovyan/.cache/torch/kernels","FASTAPI_STATIC":"/home/jovyan/workspace/samgis-lisa-on-cuda/static","VIS_OUTPUT":"/home/jovyan/workspace/samgis-lisa-on-cuda/vis_output"}'
+  export WORKDIR="$HOME/workspace/samgis-lisa-on-cuda"
+  export XDG_CACHE_HOME="$HOME/.cache"
+  export PROJECT_ROOT_FOLDER="$HOME/"
+  export MPLCONFIGDIR="$HOME/.cache/matplotlib"
+  export TRANSFORMERS_CACHE="$HOME/.cache/transformers"
+  export PYTORCH_KERNEL_CACHE_PATH="$HOME/.cache/torch/kernels"
+  export FASTAPI_STATIC="$HOME/workspace/samgis-lisa-on-cuda/static"
+  export VIS_OUTPUT="$HOME/workspace/samgis-lisa-on-cuda/vis_output"
+  ```
+
+- execute the script `baremetal_entrypoint.sh` instead than `docker_entrypoint.sh`.

scripts/baremetal_entrypoint.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+if [ -z "${WORKDIR}" ];
+then
+    WORKDIR=$1
+fi
+
+if [ -z "${XDG_CACHE_HOME}" ];
+then
+    XDG_CACHE_HOME=$HOME/.cache
+fi
+
+echo "WORKDIR: ${WORKDIR} ..."
+echo "XDG_CACHE_HOME: ${XDG_CACHE_HOME} ..."
+
+cd ${WORKDIR}
+
+if [ ! -f "${WORKDIR}/.env_source" ];
+then
+    echo "missing ${WORKDIR}/.env_source file, exit now..."
+    exit 1
+fi
+
+source ${WORKDIR}/.env_source
+echo "FOLDERS_MAP: ${FOLDERS_MAP} ..."
+
+which python
+python --version
+python ${WORKDIR}/scripts/create_folders_and_variables_if_not_exists.py
+
+cd ${WORKDIR}/static
+npm install -g npm pnpm
+pnpm install
+pnpm tailwindcss -i ${WORKDIR}/static/src/input.css -o ${WORKDIR}/static/dist/output.css
+cd ${WORKDIR}
+
+chmod +x ${WORKDIR}/scripts/entrypoint.sh
+bash ${WORKDIR}/scripts/entrypoint.sh
+
+exit 0

scripts/create_folders_and_variables_if_not_exists.py

@@ -18,6 +18,9 @@ def create_folder_if_not_exists(pathname: Path | str):
     except PermissionError as pe:
         print(f"permission denied on removing pathname before folder creation:{pe}.")
         logging.error(f"permission denied on removing pathname before folder creation:{pe}.")
+    except IsADirectoryError as errdir:
+        print(f"that's a directory:{errdir}.")
+        logging.error(f"that's a directory:{errdir}.")
 
     print(f"Creating pathname: {current_pathname} ...")
     logging.info(f"Creating pathname: {current_pathname} ...")
@@ -35,4 +38,5 @@ if __name__ == '__main__':
         print(f"folder_env_ref:{folder_env_ref}, folder_env_path:{folder_env_path}.")
         logging.info(f"folder_env_ref:{folder_env_ref}, folder_env_path:{folder_env_path}.")
         create_folder_if_not_exists(folder_env_path)
+        print("========")
         assert os.getenv(folder_env_ref) == folder_env_path

scripts/docker_entrypoint.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+export WORKDIR="/var/task"
+export XDG_CACHE_HOME="/data"
+
+echo "FOLDERS_MAP:${FOLDERS_MAP} ..."
+source ${WORKDIR}/.venv/bin/activate
+
+which python
+python --version
+python ${WORKDIR}/scripts/create_folders_and_variables_if_not_exists.py
+
+chmod +x ${WORKDIR}/scripts/entrypoint.sh
+bash ${WORKDIR}/scripts/entrypoint.sh
+
+exit 0

scripts/entrypoint.sh

@@ -1,16 +1,5 @@
 #!/usr/bin/env bash
 
-WORKDIR="/var/task"
-XDG_CACHE_HOME="/data"
-
-echo "FOLDERS_MAP:${FOLDERS_MAP} ..."
-
-source ${WORKDIR}/.venv/bin/activate
-
-which python
-python --version
-python ${WORKDIR}/scripts/create_folders_and_variables_if_not_exists.py
-
 free -m
 which nvcc || true
 nvcc -V || true