burtenshaw HF Staff commited on
Commit
525bd11
·
verified ·
1 Parent(s): cbe0084

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. src/envs/wildfire_env/README.md +35 -21
src/envs/wildfire_env/README.md CHANGED
@@ -57,15 +57,6 @@ This makes WildfireEnv a **fast, controllable**, and **open benchmark** for appl
57
 
58
  ### Using Docker (Recommended)
59
 
60
- ```bash
61
- # From the OpenEnv root directory
62
- ./run_wildfire_docker.sh
63
- ```
64
-
65
- **Note:** The web interface can be enabled with `ENABLE_WEB_INTERFACE=true`. Access it at `http://localhost:8000/web` when enabled.
66
-
67
- Or manually:
68
-
69
  ```bash
70
  # Build base image (first time only)
71
  docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
@@ -74,9 +65,11 @@ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
74
  docker build -t wildfire-env:latest -f src/envs/wildfire_env/server/Dockerfile .
75
 
76
  # Run container
77
- docker run -p 8000:8000 wildfire-env:latest
78
  ```
79
 
 
 
80
  ### Basic Python Client
81
 
82
  ```python
@@ -409,11 +402,18 @@ docker run -p 8000:8000 \
409
  wildfire-env:latest
410
  ```
411
 
412
- ### Using the Run Script
413
 
414
  ```bash
415
- # Custom configuration
416
- WILDFIRE_WIDTH=64 WILDFIRE_HEIGHT=64 WILDFIRE_HUMIDITY=0.5 ./run_wildfire_docker.sh
 
 
 
 
 
 
 
417
  ```
418
 
419
  ---
@@ -422,24 +422,32 @@ WILDFIRE_WIDTH=64 WILDFIRE_HEIGHT=64 WILDFIRE_HUMIDITY=0.5 ./run_wildfire_docker
422
 
423
  ### Option 1: Docker (Recommended)
424
 
425
- **Using the convenience script:**
426
  ```bash
427
- ./run_wildfire_docker.sh
 
 
 
 
 
 
 
428
  ```
429
 
430
- This script:
431
  - Builds the base image if needed
432
  - Rebuilds the wildfire image
433
  - Starts the container
434
  - Shows logs in real-time
435
 
436
- **Manual Docker setup:**
437
  ```bash
438
  # Build base image (first time only)
439
  docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
440
 
441
- # Build wildfire environment
442
- docker build -t wildfire-env:latest -f src/envs/wildfire_env/server/Dockerfile .
 
443
 
444
  # Run container
445
  docker run -d -p 8000:8000 --name wildfire-env-container wildfire-env:latest
@@ -795,8 +803,14 @@ The Wildfire Environment includes a **custom web interface** with visual grid di
795
  #### Using Docker
796
 
797
  ```bash
798
- # From the OpenEnv root directory
799
- ./run_wildfire_docker.sh
 
 
 
 
 
 
800
  ```
801
 
802
  Then open: `http://localhost:8000/web`
 
57
 
58
  ### Using Docker (Recommended)
59
 
 
 
 
 
 
 
 
 
 
60
  ```bash
61
  # Build base image (first time only)
62
  docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
 
65
  docker build -t wildfire-env:latest -f src/envs/wildfire_env/server/Dockerfile .
66
 
67
  # Run container
68
+ docker run -p 8000:8000 -e ENABLE_WEB_INTERFACE=true wildfire-env:latest
69
  ```
70
 
71
+ **Note:** The web interface can be enabled with `ENABLE_WEB_INTERFACE=true`. Access it at `http://localhost:8000/web` when enabled.
72
+
73
  ### Basic Python Client
74
 
75
  ```python
 
402
  wildfire-env:latest
403
  ```
404
 
405
+ ### Custom Configuration
406
 
407
  ```bash
408
+ # Build and run with custom configuration
409
+ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
410
+ docker build -t wildfire-env:latest -f src/envs/wildfire_env/server/Dockerfile .
411
+ docker run -p 8000:8000 \
412
+ -e ENABLE_WEB_INTERFACE=true \
413
+ -e WILDFIRE_WIDTH=64 \
414
+ -e WILDFIRE_HEIGHT=64 \
415
+ -e WILDFIRE_HUMIDITY=0.5 \
416
+ wildfire-env:latest
417
  ```
418
 
419
  ---
 
422
 
423
  ### Option 1: Docker (Recommended)
424
 
425
+ **Manual setup:**
426
  ```bash
427
+ # Build base image (first time only)
428
+ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
429
+
430
+ # Build wildfire environment
431
+ docker build -t wildfire-env:latest -f src/envs/wildfire_env/server/Dockerfile .
432
+
433
+ # Run container
434
+ docker run -p 8000:8000 -e ENABLE_WEB_INTERFACE=true wildfire-env:latest
435
  ```
436
 
437
+ This approach:
438
  - Builds the base image if needed
439
  - Rebuilds the wildfire image
440
  - Starts the container
441
  - Shows logs in real-time
442
 
443
+ **Alternative: Using build_docker.sh script:**
444
  ```bash
445
  # Build base image (first time only)
446
  docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
447
 
448
+ # Build wildfire environment using the script
449
+ cd src/envs/wildfire_env/server
450
+ ./build_docker.sh
451
 
452
  # Run container
453
  docker run -d -p 8000:8000 --name wildfire-env-container wildfire-env:latest
 
803
  #### Using Docker
804
 
805
  ```bash
806
+ # Build base image (first time only)
807
+ docker build -t openenv-base:latest -f src/core/containers/images/Dockerfile .
808
+
809
+ # Build wildfire environment
810
+ docker build -t wildfire-env:latest -f src/envs/wildfire_env/server/Dockerfile .
811
+
812
+ # Run container
813
+ docker run -p 8000:8000 -e ENABLE_WEB_INTERFACE=true wildfire-env:latest
814
  ```
815
 
816
  Then open: `http://localhost:8000/web`