Skip to content

00_setup.md

Latest commit

 

History

History
82 lines (54 loc) · 1.48 KB

00_setup.md

File metadata and controls

82 lines (54 loc) · 1.48 KB
Raw

Setting up your environment

This guide walks through creating a Python virtual environment and installing all eulumdat-* packages. All steps are run from the root of this repository.

1. Check Python version

Python 3.9 or later is required.

python --version      # Windows
python3 --version     # Linux / macOS

Throughout this guide, Linux and macOS users should replace python with python3 where needed.

2. Create a virtual environment

# Windows
python -m venv .venv

# Linux / macOS
python3 -m venv .venv

3. Activate the virtual environment

# Windows — Command Prompt
.venv\Scripts\activate.bat

# Windows — Git Bash
source .venv/Scripts/activate

# Linux / macOS
source .venv/bin/activate

Your prompt should now show (.venv).

4. Install all packages

pip install eulumdat-py eulumdat-symmetry eulumdat-plot \
            eulumdat-luminance eulumdat-ugr eulumdat-analysis \
            eulumdat-report eulumdat-ies

5. Install Playwright (required only for PDF generation)

pip install playwright
playwright install chromium

playwright install chromium downloads ~150 MB. If you don't need PDF output, you can skip this step — the HTML report works without Playwright.

6. Clone this repository

git clone https://github.com/123VincentB/eulumdat-quickstart.git
cd eulumdat-quickstart

Next step → Step 1 — Parsing an LDT file