chore: initial library setup

.github/workflows/ruff.yml

@@ -0,0 +1,13 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # Use ruff twice for linting and formatting.
+      # See https://github.com/astral-sh/ruff-action/issues/23#issuecomment-2525574730
+      - uses: astral-sh/ruff-action@v3
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check"

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  # pre-commit-hooks not yet in ruff: https://github.com/astral-sh/ruff/issues/4073
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: check-ast
+      - id: trailing-whitespace
+      - id: pretty-format-json
+        args:
+          - "--autofix"
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.5.8
+    hooks:
+      - id: uv-lock
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.1
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -1 +1,52 @@
-# XLand
+# XLand
+
+## Development Instructions
+
+Clone the project locally:
+
+```shell
+$ git clone [email protected]:lysj-cpu/icland.git
+$ cd icland
+```
+
+### uv (recommended)
+
+The project can be run via [uv](https://docs.astral.sh/uv/):
+
+```shell
+$ uv run python -c "import icland; print(icland.__doc__)"
+Recreating Google DeepMind's XLand RL environment in JAX.
+```
+
+[Ruff](https://docs.astral.sh/ruff/) is used for formatting.
+
+```shell
+$ uv run ruff check   # Linting
+$ uv run ruff format  # Formatting
+```
+
+You can also install [pre-commit](https://pre-commit.com/) hooks to automatically run validation checks when making a commit:
+
+```shell
+$ uv run pre-commit install
+```
+
+### pip
+
+`uv` is [preferred](https://docs.astral.sh/uv/#highlights) over pip and also installs developer dependencies. However, pip might still be useful for small modifications.
+
+First, we create and activate a [virtual environment](https://docs.python.org/3/library/venv.html):
+
+```shell
+$ python -m venv env
+$ source env/bin/activate
+```
+
+
+Then install in [editable mode](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs):
+
+```shell
+$ pip install -e .
+$ python -c "import icland; print(icland.__doc__)"
+Recreating Google DeepMind's XLand RL environment in JAX.
+```

pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "icland"
+version = "0.1.0"
+description = "Recreating Google DeepMind's XLand RL environment in JAX"
+readme = "README.md"
+authors = []
+requires-python = ">=3.13"
+dependencies = [
+    "brax>=0.12.1",
+    "mujoco>=3.2.6",
+    "mujoco-mjx>=3.2.6",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.0.1",
+    "ruff>=0.9.1",
+]
+
+[tool.ruff]
+target-version = "py313"
+
+[tool.ruff.lint]
+# Enable pydocstyle checks
+# See: https://docs.astral.sh/ruff/rules/#pydocstyle-d
+select = ["D"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

src/icland/__init__.py

@@ -0,0 +1 @@
+"""Recreating Google DeepMind's XLand RL environment in JAX."""