factoriax 0.1.0__tar.gz

factoriax-0.1.0/.gitignore

@@ -0,0 +1,244 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/api/generated/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# File types
+*.mp4
+*.png
+*.npz
+# Track the canonical sprite atlas. The renderer reads it at startup.
+!factoriax/assets/atlas.png
+# Track the README/docs title image.
+!docs/_static/title_image.png
+# Track figures that documentation pages embed. The docs build fails
+# without them, because a page references a file that is not there.
+!docs/**/_images/*.png
+
+# Performance test logs
+tests/performance/logs/
+
+# Project specific
+player_config.json
+CLAUDE.md
+craftax/
+tmp_baselines/
+experiments/
+wandb/
+levels/
+checkpoints/
+runs/
+.claude/worktrees/
+.claude/scheduled_tasks.lock
+
+# Paper lives in its own repo; not tracked here
+paper/
+docs/profiling/traces/
+
+# Profiler output
+profiled.json
+profiles/

factoriax-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mickey Beurskens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.   

factoriax-0.1.0/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.5
+Name: factoriax
+Version: 0.1.0
+Summary: A JAX-based grid environment for RL research
+Project-URL: Homepage, https://github.com/mickeybeurskens/factoriax
+Project-URL: Documentation, https://mickeybeurskens.github.io/factoriax/
+Project-URL: Repository, https://github.com/mickeybeurskens/factoriax
+Project-URL: Issues, https://github.com/mickeybeurskens/factoriax/issues
+Author-email: Mickey Beurskens <m.r.m.beurskens@tue.nl>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: benchmark,environment,factorio,gpu,jax,reinforcement-learning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: flax>=0.8.0
+Requires-Dist: gymnax>=0.0.8
+Requires-Dist: imageio[ffmpeg]>=2.33.0
+Requires-Dist: jax>=0.9.1
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: optax>=0.2.0
+Requires-Dist: orjson>=3.11.7
+Requires-Dist: pygame>=2.5.0
+Provides-Extra: cuda
+Requires-Dist: jax[cuda13]>=0.9.1; extra == 'cuda'
+Description-Content-Type: text/markdown
+
+# Factoriax
+
+> "The Factory must grow!"
+
+Factoriax is a GPU accelerated factory building simulator for reinforcement learning research in the style of the game [Factorio](https://www.factorio.com/), written in JAX.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/mickeybeurskens/factoriax/main/docs/_static/title_image.png"
+       alt="A Factoriax factory: miners on ore patches, belts that carry ore to furnaces and assemblers, and a player among them" />
+</p>
+
+[Read the documentation](https://mickeybeurskens.github.io/factoriax/)
+for the tutorial, the API reference, and the design notes. To build the
+documentation as HTML, run `cd docs && make html`.
+
+## Why Factoriax?
+
+
+Factorio is quite a cool game with an enormous amount of emergent gameplay complexity, and it is interesting to use it as a benchmark to evaluate AI systems. However, even though the game is famous for being [carefully optimized](https://www.factorio.com/blog/post/fff-421), training Reinforcement Learning agents on the base game is very slow. Factoriax is basically a simplified version of the core Factorio game mechanics that can run millions of game ticks per second on higher end GPUs (as of writing), while also running quickly enough to train models on local laptop GPUs. This allows researchers to test their RL ideas in Factoriax at scale, while allowing students to get familiar with RL concepts without the need for enormous GPU clusters.
+
+And honestly, Factorio is just a lot of fun. Even though the Factoriax implementation of the original game mechanics is quite minimal, I hope it does some justice to the original game.
+
+## Installation
+
+To install the most recent release from PyPi, run this command:
+
+```bash
+pip install factoriax
+```
+
+To install it with uv, run this command instead:
+
+```bash
+uv add factoriax
+```
+
+### GPU Support
+
+Factoriax installs the CPU version of JAX by default. Read
+[the JAX documentation](https://docs.jax.dev/en/latest/installation.html#installation)
+to find the version of JAX for your hardware. If your system supports CUDA13,
+run this command after you install Factoriax:
+
+```bash
+pip install "jax[cuda13]"
+```
+
+To do the same with uv, run this command:
+
+```bash
+uv pip install "jax[cuda13]"
+```
+
+### Most Recent Build For Research
+
+Install an editable build if you want the most recent commit on main. Install
+an editable build also if you want to change the source code of Factoriax
+while you work on your own project.
+
+```bash
+git clone https://github.com/mickeybeurskens/factoriax.git
+pip install -e ./factoriax
+```
+
+To do the same with uv, run these commands:
+
+```bash
+git clone https://github.com/mickeybeurskens/factoriax.git
+uv add --editable ./factoriax
+```
+
+### Development Build
+
+The development build keeps the development packages in sync. Do not use it if
+you include Factoriax as a dependency of your own project.
+
+```bash
+git clone https://github.com/mickeybeurskens/factoriax.git
+uv sync
+```
+
+`uv sync` removes the GPU version of JAX. To keep the GPU version, run this
+command instead:
+
+```bash
+uv sync --extra cuda
+```
+
+## Play The Game 
+
+Factoriax has a human playable interface, called the playground. It contains a human playable version of Factoriax and a level editor.
+
+To open the playground, run this command:
+
+```bash
+python -m factoriax.playground
+```
+
+More information is available [in the documentation](https://mickeybeurskens.github.io/factoriax/start_here/playing_manually.html).
+
+## Build An Environment
+
+```python
+import jax
+
+from factoriax.make import env_from_name
+
+env, params = env_from_name("EasyRocket-v1")
+obs, state = env.reset_env(jax.random.PRNGKey(0), params)
+```
+
+Three scenarios have an id: `MinerBootstrap-v1`, `EasyRocket-v1`, and
+`Rocket-v1`. The function `factoriax.engine.envs.registry.list_scenarios`
+returns each id with its specification.
+
+## Development
+
+To run the tests, the linter, and the documentation build, run these commands:
+
+```bash
+uv run pytest
+uv run ruff check factoriax tests
+```
+
+## Citation
+
+Factoriax was initially submitted in a workshop paper at the 19th European Workshop on
+Reinforcement Learning (EWRL 2026). If you use Factoriax in your research then please cite:
+
+```bibtex
+@inproceedings{beurskens2026factoriax,
+  title     = {{Factoriax - A GPU-Accelerated Factory Building Simulator In The Style Of Factorio}},
+  author    = {Beurskens, Mickey and Tomilin, Tristan and Sim{\~a}o, Thiago D.},
+  booktitle = {19th European Workshop on Reinforcement Learning (EWRL)},
+  year      = {2026},
+  address   = {Lille, France},
+  url       = {https://ewrl-org.github.io/ewrl-2026/poster_148.html}
+}
+```
+

factoriax-0.1.0/README.md

@@ -0,0 +1,140 @@
+# Factoriax
+
+> "The Factory must grow!"
+
+Factoriax is a GPU accelerated factory building simulator for reinforcement learning research in the style of the game [Factorio](https://www.factorio.com/), written in JAX.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/mickeybeurskens/factoriax/main/docs/_static/title_image.png"
+       alt="A Factoriax factory: miners on ore patches, belts that carry ore to furnaces and assemblers, and a player among them" />
+</p>
+
+[Read the documentation](https://mickeybeurskens.github.io/factoriax/)
+for the tutorial, the API reference, and the design notes. To build the
+documentation as HTML, run `cd docs && make html`.
+
+## Why Factoriax?
+
+
+Factorio is quite a cool game with an enormous amount of emergent gameplay complexity, and it is interesting to use it as a benchmark to evaluate AI systems. However, even though the game is famous for being [carefully optimized](https://www.factorio.com/blog/post/fff-421), training Reinforcement Learning agents on the base game is very slow. Factoriax is basically a simplified version of the core Factorio game mechanics that can run millions of game ticks per second on higher end GPUs (as of writing), while also running quickly enough to train models on local laptop GPUs. This allows researchers to test their RL ideas in Factoriax at scale, while allowing students to get familiar with RL concepts without the need for enormous GPU clusters.
+
+And honestly, Factorio is just a lot of fun. Even though the Factoriax implementation of the original game mechanics is quite minimal, I hope it does some justice to the original game.
+
+## Installation
+
+To install the most recent release from PyPi, run this command:
+
+```bash
+pip install factoriax
+```
+
+To install it with uv, run this command instead:
+
+```bash
+uv add factoriax
+```
+
+### GPU Support
+
+Factoriax installs the CPU version of JAX by default. Read
+[the JAX documentation](https://docs.jax.dev/en/latest/installation.html#installation)
+to find the version of JAX for your hardware. If your system supports CUDA13,
+run this command after you install Factoriax:
+
+```bash
+pip install "jax[cuda13]"
+```
+
+To do the same with uv, run this command:
+
+```bash
+uv pip install "jax[cuda13]"
+```
+
+### Most Recent Build For Research
+
+Install an editable build if you want the most recent commit on main. Install
+an editable build also if you want to change the source code of Factoriax
+while you work on your own project.
+
+```bash
+git clone https://github.com/mickeybeurskens/factoriax.git
+pip install -e ./factoriax
+```
+
+To do the same with uv, run these commands:
+
+```bash
+git clone https://github.com/mickeybeurskens/factoriax.git
+uv add --editable ./factoriax
+```
+
+### Development Build
+
+The development build keeps the development packages in sync. Do not use it if
+you include Factoriax as a dependency of your own project.
+
+```bash
+git clone https://github.com/mickeybeurskens/factoriax.git
+uv sync
+```
+
+`uv sync` removes the GPU version of JAX. To keep the GPU version, run this
+command instead:
+
+```bash
+uv sync --extra cuda
+```
+
+## Play The Game 
+
+Factoriax has a human playable interface, called the playground. It contains a human playable version of Factoriax and a level editor.
+
+To open the playground, run this command:
+
+```bash
+python -m factoriax.playground
+```
+
+More information is available [in the documentation](https://mickeybeurskens.github.io/factoriax/start_here/playing_manually.html).
+
+## Build An Environment
+
+```python
+import jax
+
+from factoriax.make import env_from_name
+
+env, params = env_from_name("EasyRocket-v1")
+obs, state = env.reset_env(jax.random.PRNGKey(0), params)
+```
+
+Three scenarios have an id: `MinerBootstrap-v1`, `EasyRocket-v1`, and
+`Rocket-v1`. The function `factoriax.engine.envs.registry.list_scenarios`
+returns each id with its specification.
+
+## Development
+
+To run the tests, the linter, and the documentation build, run these commands:
+
+```bash
+uv run pytest
+uv run ruff check factoriax tests
+```
+
+## Citation
+
+Factoriax was initially submitted in a workshop paper at the 19th European Workshop on
+Reinforcement Learning (EWRL 2026). If you use Factoriax in your research then please cite:
+
+```bibtex
+@inproceedings{beurskens2026factoriax,
+  title     = {{Factoriax - A GPU-Accelerated Factory Building Simulator In The Style Of Factorio}},
+  author    = {Beurskens, Mickey and Tomilin, Tristan and Sim{\~a}o, Thiago D.},
+  booktitle = {19th European Workshop on Reinforcement Learning (EWRL)},
+  year      = {2026},
+  address   = {Lille, France},
+  url       = {https://ewrl-org.github.io/ewrl-2026/poster_148.html}
+}
+```
+

factoriax-0.1.0/factoriax/__init__.py

@@ -0,0 +1,13 @@
+"""Factoriax: a JAX grid environment for reinforcement learning research.
+
+The package holds four parts. :mod:`factoriax.engine` is the simulation, the
+environments, and the wrappers. :mod:`factoriax.analysis` reads a recorded
+rollout. :mod:`factoriax.playground` is the human interface, which is the
+game and the level editor. :mod:`factoriax.assets` builds the sprite atlas.
+
+Build an environment with :func:`factoriax.make.env_from_name`. Start the
+playground with ``python -m factoriax.playground``.
+
+This module holds no imports, so a training run pulls in the engine only, and
+never pygame. Import from the defining module instead.
+"""

factoriax-0.1.0/factoriax/analysis/__init__.py

@@ -0,0 +1,23 @@
+"""Tools for reading and drawing recorded episodes.
+
+:class:`~factoriax.analysis.trajectory.Trajectory` is the shared input
+format. Every plot in this package takes one.
+
+Importing this package imports the five submodules listed in
+``__all__``, and therefore matplotlib. The other modules
+(``build_progression``, ``categories``, ``curriculum_strip``,
+``graph_layout``, ``inventory``, ``recipe_graph``, ``recorder``, and
+``utils``) are not re-exported here. Import them by their full path.
+"""
+
+from . import actions, eval, milestones, state, video
+from .trajectory import Trajectory
+
+__all__ = [
+    "Trajectory",
+    "actions",
+    "eval",
+    "milestones",
+    "state",
+    "video",
+]