# Imitation Learning Performance Evaluation Package — Installation Guide (Anaconda)

## 1. Python Version

| Item | Recommended |
|------|-------------|
| **Python** | **3.8** or higher (3.9, 3.10, 3.11 recommended) |

- This package uses **only the standard library** (tkinter, threading, json, dataclasses, etc.).
- Python 3.8+ is sufficient for type hints and dataclasses.

---

## 2. Requirements

- **No extra pip packages required.**  
  GUI (tkinter) is included with Python, so no additional installation is needed.
- **Exact image scaling (optional):** To display the top diagram (`picture2.png`) at the scale set by `IMG_DISPLAY_SCALE`, **Pillow** is required.  
  Without it, scaling is approximate.  
  `pip install Pillow`
- If your training script uses `training_checkpoint_logger` with **PyTorch** or similar to save models, install those in your environment (PyTorch, numpy, etc.).  
  This evaluation package does **not** require `torch`.

---

## 3. Install and Run with Anaconda

### 3.1 Create environment

```bash
# Example for Python 3.10 (3.8, 3.9, 3.11 also work)
conda create -n metrics_eval python=3.10 -y
conda activate metrics_eval
```

### 3.2 Install dependencies (optional)

If you only use this repository’s code, **you don’t need to install anything else**.

```bash
# From project root if needed (requirements.txt may be empty)
pip install -r requirements.txt
```

If you also run training in the same environment:

```bash
# Example: PyTorch etc. (for training only, not required by this package)
# conda install pytorch numpy -c pytorch
# or
# pip install torch numpy
```

### 3.3 Run

From the project root (e.g. `Works_NIST`):

```bash
conda activate metrics_eval
python run_evaluation.py
```

Or:

```bash
python -m metrics_eval.runner
```

If the GUI opens, installation and run are successful. The GUI is in English (e.g. **Start Test**, **Evaluation Settings**, **Learning time log (txt, minutes)**).

---

## 4. When tkinter is missing (Linux)

On some minimal Linux installs, tkinter may not be installed. Install it only if needed:

```bash
# Ubuntu / Debian
sudo apt-get install python3-tk

# With conda
conda install tk
```

Then run `python run_evaluation.py` again.

---

## 5. Korean / CJK characters showing as boxes (Linux)

Tk (tkinter) can only use **fonts that the system has registered**.  
Fonts placed in `~/.local/share/fonts/` (e.g. Pretendard) are often not visible to Tk, so CJK text may render as boxes.

**Recommended: install system CJK fonts and restart session**

1. **Install Noto CJK (system-wide)**  
   ```bash
   sudo apt-get update
   sudo apt-get install fonts-noto-cjk
   sudo fc-cache -fv
   ```
2. **Log out and log back in** (or reboot)  
   Tk reads the font list at session start; restarting the terminal alone may not be enough.
3. Run `python run_evaluation.py` again.

**Check in terminal**  
To see if CJK fonts are available:
```bash
fc-list :lang=ko | head -3
```
If Noto (or similar) appears, **log out and log back in**, then run the app.

**Using Pretendard**  
To make Pretendard visible to Tk: install the font, run `fc-cache`, then **log out and log back in**. If Pretendard still does not appear in `tkfont.families()`, Tk cannot use it in that environment.

---

## 6. Summary

| Item | Description |
|------|-------------|
| Python | 3.8+ (3.9–3.11 recommended) |
| Extra packages | None (standard library only) |
| GUI | tkinter (included with Python) |
| Run | `conda activate <env>` then `python run_evaluation.py` |
| CJK broken (Linux) | Install CJK fonts, run `fc-cache -fv`, then log out and log back in |