icland 0.1.0a2

Recreating Google DeepMind's XLand RL environment in JAX

ICLand

Development Instructions

Clone the project locally:

$ git clone [e-mail]:lysj-cpu/icland.git
$ cd icland

uv (recommended)

The project can be run via uv:

$ uv run python -c "import icland; print(icland.__doc__)"
Recreating Google DeepMind's XLand RL environment in JAX.

Ruff is used for formatting.

$ uv run ruff check   # Linting
$ uv run ruff format  # Formatting

You can also install pre-commit hooks to automatically run validation checks when making a commit:

$ uv run pre-commit install

pip

uv is preferred over pip and also installs developer dependencies. However, pip might still be useful for small modifications.

First, we create and activate a virtual environment:

$ python -m venv env
$ source env/bin/activate

Then install in editable mode:

$ pip install -e .
$ python -c "import icland; print(icland.__doc__)"
Recreating Google DeepMind's XLand RL environment in JAX.