pySunlight Docker

• pySunlight Docker
  • About The Project
  • Getting Started
    • Install
    • Usage
      • Configure
      • With Docker Compose
      • With DockerFile

About The Project

It's a dockerised version of pySunlight program.

pySunlight-docker is one repository of the Sunlight project, including :

• Sunlight
• pySunlight
• pySunlight-docker
• UD-Demo-VCity-Sunlight

Getting Started

Install

Clone the repository.

git clone https://github.com/VCityTeam/pySunlight-docker.git

Usage

Configure

1. Copy and rename .env.example to . env.

2. Adapt the configuration to your needs. Here is a full list of all options available :

Arguments	Description	Example
START_DATE	Start date of sunlight computation	403224
END_DATE	End date of sunlight computation	403248
LOG_LEVEL	Provide logging level depending on logging module	DEBUG, INFO, WARNING, ERROR, CRITICAL
INPUTS_FOLDER	Inputs folder containing 3D Tiles use for sunlight computation	./inputs
OUTPUTS_FOLDER	Outputs folder containing 3D Tiles with Sunlight Result in batch table	./outputs
OPTIONAL_ARGS	Optional arguments (compute aggregate...)	--with-aggregate

3. Create two folders named inputs and outputs. Place your 3DTiles in the inputs folder (it can be in a subfolder).

With Docker Compose

1. Build pySunlight docker-compose :

   docker compose build

2. Run the container with :

   docker compose up

With DockerFile

1. Build pySunlight DockerFile :

   docker build -t pysunlight --file Context/Dockerfile .

2. Run dockerfile with .env file :

   docker run -v ./inputs:/inputs -v ./outputs:/outputs --env-file .env pysunlight

   or run docker file with arguments :

   docker run -v ./inputs:/inputs -v ./outputs:/outputs -e START_DATE=403224 -e END_DATE=403248 -e LOG_LEVEL=DEBUG -e OPTIONAL_ARGS=--with-aggregate pysunlight