factory-sim 0.1.1__tar.gz

factory_sim-0.1.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

factory_sim-0.1.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include build_fsim.py LICENSE NOTICE README.md
+include csrc/fsim.c csrc/fsim.h csrc/fsim_rl.c

factory_sim-0.1.1/NOTICE

@@ -0,0 +1,29 @@
+factory-sim
+Copyright 2026 Divyansh Agrawal
+Licensed under the Apache License, Version 2.0; see LICENSE.
+
+Factorio
+--------
+Factorio is a game by Wube Software Ltd. "Factorio" is a trademark of Wube
+Software Ltd. This project is independent. It is not affiliated with,
+sponsored by, or endorsed by Wube Software Ltd.
+
+What this is
+------------
+A small simulator of a few early-game mechanics, written from scratch. Every
+rule and number in it comes from this project's own measurements of the
+running game, recorded by FactorioRL (its docs/evidence/). No Factorio code,
+data files, prototype definitions, art, sound or fonts were copied or are
+included, and nothing here draws anything that imitates the game.
+
+The golden traces under tests/golden/, and fsim/data/terrain.json, are
+measurements FactorioRL recorded of its own scenarios in the running game:
+positions, ticks, counts and names. They are included for parity testing and
+contain no game code or assets.
+
+Rules for contributors
+----------------------
+- Never copy code or data from the game or from projects whose licence does
+  not allow it. Measure behaviour and write it down; then implement it.
+- Never commit game binaries, graphics, sounds, fonts, locale files, saves or
+  prototype dumps.

factory_sim-0.1.1/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: factory-sim
+Version: 0.1.1
+Summary: A fast, tick-exact simulator of an early-game factory, checked against recorded traces of the real game.
+Author: Divyansh Agrawal
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: cffi>=1.17
+Requires-Dist: numpy>=2
+Provides-Extra: gym
+Requires-Dist: gymnasium>=1.0; extra == "gym"
+Provides-Extra: puffer
+Requires-Dist: gymnasium>=1.0; extra == "puffer"
+Requires-Dist: gym>=0.26; extra == "puffer"
+Requires-Dist: psutil; extra == "puffer"
+Dynamic: license-file
+
+# factory-sim
+
+A fast C simulator of a small slice of Factorio's early game: a character
+walking, reaching and hand-mining; burner mining drills; stone furnaces; fuel;
+ground item piles. It exists to train reinforcement-learning policies quickly,
+with the real game kept as the verifier.
+
+It is checked, decision by decision and tick by tick, against golden traces
+recorded on Factorio 2.0.60 by [FactorioGym](https://github.com/divagr18/FactorioGym).
+A mechanic is added here only after it has been measured there.
+
+## Status
+
+M3, the simulator core, is done:
+
+- All 12 golden scenarios match the real game at every decision, in both
+  free-running and one-step sync.
+- All 8 tick-level traces match on every tick.
+- A single environment runs 173k decisions/s, and 8 threads run 850k in total
+  (`bench/RESULTS.md`).
+
+M4, the RL contract, is done too. `fsim.rl.RlEnv` speaks FactorioRL's
+`parameterized-v1` action space (`MultiDiscrete[22, 33, 122, 5, 15, 4]`) and its
+`local-v2` tensor observation for `construct_smelting_line` and `build_line`:
+
+- It covers the encoder, argument domains, the action mask, vector decoding,
+  the goal vector, rewards, termination, and the verification window.
+- Driven by each golden trace's recorded action vectors, every decision
+  matches FactorioRL:
+  - each encoded tensor hashes identically, bit for bit;
+  - the mask, goal, reward, reward components, termination, truncation,
+    success and decode failures all match.
+- The whole RL path runs 60k decisions/s on one environment and 382k on
+  eight threads.
+
+Next is M5: a PPO learner trained here, then evaluated on the real game through
+FactorioRL.
+
+What it simulates today:
+
+- **Character**: 4-way walking, with collision against walls, machines and
+  water. Reach and build distance. Hand-mining ore and picking machines back up.
+- **Burner mining drill**: fuel and energy buffer, mining progress, drop
+  position per facing, delivery into a furnace or onto the ground, jams.
+- **Stone furnace**: iron smelting, fuel, the 54-ore source slot, idle and
+  no-fuel states.
+- **Transfers**: clamped transfers, with the same choice of slot and the same
+  refusals as the game.
+- **Bookkeeping**:
+  - handles, running actions and the event log, as FactorioRL's mod keeps them;
+  - production statistics, and the `steam-power` trigger 24 ticks after the
+    50th plate.
+
+How parity is judged:
+
+- Doubles are compared to within 1e-12. The game prints some doubles with an
+  imprecise last digit, and one progress bar is matched to about one part in
+  10^14.
+- Ore under a drill is compared as a total over the drill's four tiles. The
+  order a drill visits its tiles follows the engine's internal entity order,
+  which could not be reduced to a rule, and the encoder cannot see the
+  difference.
+- Everything else must match exactly.
+
+## Install
+
+```
+pip install git+https://github.com/divagr18/factory-sim   # compiles csrc/: needs a C compiler
+```
+
+This installs the simulator (`fsim`) and the program-search loop (`evolve`); the
+benchmark map ships inside the package. Extras: `[gym]` for the Gymnasium
+adapter, `[puffer]` for PufferLib's (see `docs/interfaces.md`).
+
+## Build and test
+
+```
+uv sync                         # installs the checkout editable, compiling csrc/
+uv run python build_fsim.py          # rebuilds fsim/_fsim in place after a C change
+uv run pytest                   # parity against tests/golden
+uv run python bench/bench.py
+```
+
+`tools/sync_golden.py --from ../FactorioRL` refreshes the golden traces from a
+FactorioRL checkout, checking every trace's hash.
+
+## Citing
+
+If you use factory-sim in academic work, please cite it. GitHub's "Cite this
+repository" button reads [CITATION.cff](CITATION.cff); in BibTeX:
+
+```bibtex
+@software{agrawal2026factorysim,
+  author  = {Agrawal, Divyansh},
+  title   = {{factory-sim}: a fast, tick-exact simulator of an early-game factory},
+  year    = {2026},
+  version = {0.1.1},
+  url     = {https://github.com/divagr18/factory-sim},
+  license = {Apache-2.0}
+}
+```
+
+## License
+
+Apache-2.0; see [LICENSE](LICENSE). See [NOTICE](NOTICE) for what this project
+does and does not contain.

factory_sim-0.1.1/README.md

@@ -0,0 +1,106 @@
+# factory-sim
+
+A fast C simulator of a small slice of Factorio's early game: a character
+walking, reaching and hand-mining; burner mining drills; stone furnaces; fuel;
+ground item piles. It exists to train reinforcement-learning policies quickly,
+with the real game kept as the verifier.
+
+It is checked, decision by decision and tick by tick, against golden traces
+recorded on Factorio 2.0.60 by [FactorioGym](https://github.com/divagr18/FactorioGym).
+A mechanic is added here only after it has been measured there.
+
+## Status
+
+M3, the simulator core, is done:
+
+- All 12 golden scenarios match the real game at every decision, in both
+  free-running and one-step sync.
+- All 8 tick-level traces match on every tick.
+- A single environment runs 173k decisions/s, and 8 threads run 850k in total
+  (`bench/RESULTS.md`).
+
+M4, the RL contract, is done too. `fsim.rl.RlEnv` speaks FactorioRL's
+`parameterized-v1` action space (`MultiDiscrete[22, 33, 122, 5, 15, 4]`) and its
+`local-v2` tensor observation for `construct_smelting_line` and `build_line`:
+
+- It covers the encoder, argument domains, the action mask, vector decoding,
+  the goal vector, rewards, termination, and the verification window.
+- Driven by each golden trace's recorded action vectors, every decision
+  matches FactorioRL:
+  - each encoded tensor hashes identically, bit for bit;
+  - the mask, goal, reward, reward components, termination, truncation,
+    success and decode failures all match.
+- The whole RL path runs 60k decisions/s on one environment and 382k on
+  eight threads.
+
+Next is M5: a PPO learner trained here, then evaluated on the real game through
+FactorioRL.
+
+What it simulates today:
+
+- **Character**: 4-way walking, with collision against walls, machines and
+  water. Reach and build distance. Hand-mining ore and picking machines back up.
+- **Burner mining drill**: fuel and energy buffer, mining progress, drop
+  position per facing, delivery into a furnace or onto the ground, jams.
+- **Stone furnace**: iron smelting, fuel, the 54-ore source slot, idle and
+  no-fuel states.
+- **Transfers**: clamped transfers, with the same choice of slot and the same
+  refusals as the game.
+- **Bookkeeping**:
+  - handles, running actions and the event log, as FactorioRL's mod keeps them;
+  - production statistics, and the `steam-power` trigger 24 ticks after the
+    50th plate.
+
+How parity is judged:
+
+- Doubles are compared to within 1e-12. The game prints some doubles with an
+  imprecise last digit, and one progress bar is matched to about one part in
+  10^14.
+- Ore under a drill is compared as a total over the drill's four tiles. The
+  order a drill visits its tiles follows the engine's internal entity order,
+  which could not be reduced to a rule, and the encoder cannot see the
+  difference.
+- Everything else must match exactly.
+
+## Install
+
+```
+pip install git+https://github.com/divagr18/factory-sim   # compiles csrc/: needs a C compiler
+```
+
+This installs the simulator (`fsim`) and the program-search loop (`evolve`); the
+benchmark map ships inside the package. Extras: `[gym]` for the Gymnasium
+adapter, `[puffer]` for PufferLib's (see `docs/interfaces.md`).
+
+## Build and test
+
+```
+uv sync                         # installs the checkout editable, compiling csrc/
+uv run python build_fsim.py          # rebuilds fsim/_fsim in place after a C change
+uv run pytest                   # parity against tests/golden
+uv run python bench/bench.py
+```
+
+`tools/sync_golden.py --from ../FactorioRL` refreshes the golden traces from a
+FactorioRL checkout, checking every trace's hash.
+
+## Citing
+
+If you use factory-sim in academic work, please cite it. GitHub's "Cite this
+repository" button reads [CITATION.cff](CITATION.cff); in BibTeX:
+
+```bibtex
+@software{agrawal2026factorysim,
+  author  = {Agrawal, Divyansh},
+  title   = {{factory-sim}: a fast, tick-exact simulator of an early-game factory},
+  year    = {2026},
+  version = {0.1.1},
+  url     = {https://github.com/divagr18/factory-sim},
+  license = {Apache-2.0}
+}
+```
+
+## License
+
+Apache-2.0; see [LICENSE](LICENSE). See [NOTICE](NOTICE) for what this project
+does and does not contain.

factory_sim-0.1.1/build_fsim.py

@@ -0,0 +1,64 @@
+"""Compile csrc/ into the `fsim._fsim` extension (cffi, API mode).
+
+Installing the package compiles it (setup.py names `ffibuilder` below). For a
+checkout used in place, without installing:
+
+uv run python build_fsim.py
+"""
+
+from __future__ import annotations
+
+import os
+import sys
+from pathlib import Path
+
+from cffi import FFI
+
+ROOT = Path(__file__).resolve().parent
+CSRC = ROOT / "csrc"
+
+
+def cdef_from_header(text: str) -> str:
+    """The part of fsim.h between the CFFI markers, which cffi can parse."""
+    start = text.index("/* CFFI-BEGIN */") + len("/* CFFI-BEGIN */")
+    end = text.index("/* CFFI-END */")
+    return text[start:end]
+
+
+def make_ffi(root: Path | None = None) -> FFI:
+    """The extension's builder. Paths are relative to the project root, where
+    setuptools builds from, so no sdist or wheel carries this machine's paths;
+    `root` makes them absolute for `ffi.compile`, which works in a temp dir."""
+    base = f"{root.as_posix()}/" if root else ""
+    ffi = FFI()
+    ffi.cdef(cdef_from_header((CSRC / "fsim.h").read_text(encoding="utf-8")))
+    windows = sys.platform == "win32"
+    # fsim.c includes fsim_rl.c.
+    ffi.set_source(
+        "fsim._fsim",
+        '#include "fsim.h"',
+        sources=[f"{base}csrc/fsim.c"],
+        include_dirs=[f"{base}csrc"],
+        depends=[f"{base}csrc/fsim.h", f"{base}csrc/fsim_rl.c"],
+        extra_compile_args=["/std:c11", "/O2", "/fp:precise"]
+        if windows
+        else ["-std=c11", "-O2", "-ffp-contract=off"],
+    )
+    return ffi
+
+
+ffibuilder = make_ffi()
+
+
+def main() -> int:
+    os.chdir(ROOT)
+    make_ffi(ROOT).compile(tmpdir=str(ROOT / "build"), verbose=False, target=None)
+    built = sorted((ROOT / "build" / "fsim").glob("_fsim*"))
+    for path in built:
+        (ROOT / "fsim" / path.name).write_bytes(path.read_bytes())
+    print("built", [p.name for p in built])
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())