An open API service indexing awesome lists of open source software.

https://github.com/kajilabteam/xdr_challenge_2025


https://github.com/kajilabteam/xdr_challenge_2025

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README

          

# xDR Challenge 2025

## セットアップ
### 仮想環境の作成
```bash
python -m venv .venv
```

### 仮想環境のアクティベート
VSCode の `Python: Select Interpreter` で `.venv` を選択するか、以下のコマンドを実行します。

```bash
source /Users/satooru/Documents/kajilab/xdr-challenge/xdr_challenge_2025/.venv/bin/activate
```

### 必要なパッケージのインストール
```bash
pip install -r requirements.txt
```

### 環境変数の設定
※本番環境のみ

```bash
cp .env.example .env.competition
```

`.env.demo` の変更を反映しない設定
```bash
git update-index --assume-unchanged .env.demo
```

`.env.demo` の変更を反映しない設定の解除
```bash
git update-index --no-assume-unchanged .env.demo
```

## 実行方法
### デモ環境
```bash
python main.py --demo
```

### 本番環境
```bash
python main.py
```

### オプション
| オプション | 省略形 | デフォルト値 | 説明 |
| ------------------------- | ------ | ------------ | ---------------------------------------------------------------------------------- |
| `--demo` | `-d` | `False` | デモ環境で実行します。環境変数は `.env.demo` を使用します。 |
| `--immediate` | `-i` | `False` | 即時実行モードで実行します。 |
| `--gridsearch` | `-g` | `False` | グリッドサーチモードで実行します。 |
| `--gridsearch-maxthreads` | `-gt` | `10` | グリッドサーチ時の最大スレッド数。 |
| `--maxwait` | `-w` | `0.5` | nextdata 取得・送信時の間隔。単位は秒 |
| `--loglevel` | `-l` | `info` | ログの出力レベル。`debug`, `info`, `warning`, `error`, `critical` から選択します。 |
| `--run-server` | `-r` | `False` | ローカルの EvAAL API サーバーを起動します。本番環境では使用できません。 |
| `--output-dir` | `-o` | `output` | 出力ディレクトリ。 |
| `--show-plot-map` | `-s` | `False` | 推定結果をマップに表示します。デフォルトでは表示しません。 |
| `--no-save-plot-map` | `-ns` | `False` | 推定結果をマップに保存しません。デフォルトでは保存します。 |

### 例
```bash
python main.py --demo -is
```