diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..afa25d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to Restaurant Sim (REST-bench) + +We welcome contributions from the community! By contributing to this project, you agree to the following terms. + +## Contributor License Agreement (CLA) + +By submitting code contributions (pull requests, patches, or any other form of code submission) to this project, you agree that: + +1. **Copyright Assignment**: You assign all copyright and related rights in your contributions to **MIH AI B.V.** + +2. **Licensing**: Your contributions will be licensed under the same license as this project (Apache License 2.0). + +3. **Originality**: You represent that your contributions are your original work and that you have the right to assign the copyright to MIH AI B.V. + +4. **No Conflicting Obligations**: You are not subject to any agreement or obligation that would prevent you from making these contributions. + +## How to Contribute + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/amazing-feature`) +3. Commit your changes (`git commit -m 'Add amazing feature'`) +4. Push to the branch (`git push origin feature/amazing-feature`) +5. Open a Pull Request + +## Code Review Process + +All submissions require review before being merged. We will: +- Review code quality and consistency +- Run automated tests +- Verify compliance with project standards + +## Questions? + +If you have questions about the contribution process or CLA, please contact the project maintainers or Prosus Legal. + +--- + +**By submitting a contribution, you acknowledge that you have read and agree to the terms above.** diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9ec0dcd --- /dev/null +++ b/LICENSE @@ -0,0 +1,190 @@ + 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 + + Copyright © 2026 MIH AI B.V. + + 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. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..1cf88ee --- /dev/null +++ b/NOTICE @@ -0,0 +1,18 @@ +Restaurant Sim (REST-bench) — The Rotterdam Table +Copyright © 2026 MIH AI B.V. + +This product is licensed under the Apache License, Version 2.0. + +This software includes third-party open source software components. +The following is a list of these components with their respective licenses: + +================================================================================ +THIRD-PARTY DEPENDENCIES +================================================================================ + +Runtime dependencies: +-------------------------------------------------------------------------------- +Component: NumPy License: BSD-3-Clause Source: https://github.com/numpy/numpy + +For complete license texts, see the LICENSE files in the respective dependencies +or visit the source repositories. diff --git a/README.md b/README.md index df80d1e..5608cb5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Restaurant Sim — The Rotterdam Table +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + A 30-day restaurant management simulation for **The Rotterdam Table**, a 22-table, 78-seat casual full-service bistro on Witte de Withstraat, Rotterdam. Designed as a benchmark for LLM management agents: the agent @@ -169,3 +171,21 @@ pytest -q - `test_score.py` — profit-only score + bankruptcy - `test_phase2.py` — cohorts + reviews + supplier news - `test_phase4.py` — manager view masking + +--- + +## License + +Copyright © 2026 MIH AI B.V. + +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. diff --git a/pyproject.toml b/pyproject.toml index 61b425e..c1e644d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,6 +7,12 @@ name = "rest_sim" version = "0.2.0" description = "Restaurant management simulation — The Rotterdam Table" requires-python = ">=3.10" +license = "Apache-2.0" +authors = [{ name = "MIH AI B.V." }] +classifiers = [ + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python :: 3", +] dependencies = ["numpy>=1.24"] [tool.pytest.ini_options] diff --git a/rest_sim/__init__.py b/rest_sim/__init__.py index e69de29..d759e8a 100644 --- a/rest_sim/__init__.py +++ b/rest_sim/__init__.py @@ -0,0 +1,4 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + diff --git a/rest_sim/__main__.py b/rest_sim/__main__.py index 389ecab..cbfdb12 100644 --- a/rest_sim/__main__.py +++ b/rest_sim/__main__.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """CLI for the restaurant management simulation. Designed for single-shot invocations: each command reads the persistent diff --git a/rest_sim/cohorts.py b/rest_sim/cohorts.py index c7fc767..a94eb7c 100644 --- a/rest_sim/cohorts.py +++ b/rest_sim/cohorts.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Customer cohort dynamics — Phase 2.1. Replaces the bare reputation-multiplier with a slow-moving population diff --git a/rest_sim/config.py b/rest_sim/config.py index 4a1e46d..3d1c873 100644 --- a/rest_sim/config.py +++ b/rest_sim/config.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """ Static configuration for the digital twin: the restaurant identity, the menu, the floor plan, and the staff roster. diff --git a/rest_sim/dashboard.py b/rest_sim/dashboard.py index 1506700..50cd6ab 100644 --- a/rest_sim/dashboard.py +++ b/rest_sim/dashboard.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Real-time dashboard server for the restaurant simulation. Long-running stdlib HTTP server (no external deps). The CLI pushes events diff --git a/rest_sim/dashboard_client.py b/rest_sim/dashboard_client.py index cf1d196..a200116 100644 --- a/rest_sim/dashboard_client.py +++ b/rest_sim/dashboard_client.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """CLI-side helper that pushes simulation events to the dashboard server. All HTTP work goes through `post()`, which never raises so a dead or diff --git a/rest_sim/day_sim.py b/rest_sim/day_sim.py index 9bba165..36e9603 100644 --- a/rest_sim/day_sim.py +++ b/rest_sim/day_sim.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Single-day simulation that consumes GameState and returns per-day KPIs. Adapted from simulate.py, but: diff --git a/rest_sim/distributions.py b/rest_sim/distributions.py index 92cf8e5..d22315b 100644 --- a/rest_sim/distributions.py +++ b/rest_sim/distributions.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """ Statistical distributions for the restaurant digital twin. diff --git a/rest_sim/economy.py b/rest_sim/economy.py index f5c51b8..e77f9c4 100644 --- a/rest_sim/economy.py +++ b/rest_sim/economy.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Economic layer: cash flow, payroll, fixed costs, inventory, shocks.""" from __future__ import annotations diff --git a/rest_sim/game_state.py b/rest_sim/game_state.py index dccbc93..237add1 100644 --- a/rest_sim/game_state.py +++ b/rest_sim/game_state.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Persistent game state for the restaurant management simulation. Single JSON file on disk. All mutations go through load/save. diff --git a/rest_sim/observability.py b/rest_sim/observability.py index 1a8b3a5..45a402f 100644 --- a/rest_sim/observability.py +++ b/rest_sim/observability.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Report generators for the management game.""" from __future__ import annotations diff --git a/rest_sim/reviews.py b/rest_sim/reviews.py index b5c0fc8..b4eed74 100644 --- a/rest_sim/reviews.py +++ b/rest_sim/reviews.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Delayed review queue — Phase 2.2. Replaces the old direct EWMA on raw same-day satisfaction with a diff --git a/rest_sim/tuning.py b/rest_sim/tuning.py index c3bc2be..0f2056e 100644 --- a/rest_sim/tuning.py +++ b/rest_sim/tuning.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Central tuning knobs for the simulation. Every constant the day-sim or economy uses to *interpret* state lives diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..d759e8a 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,4 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + diff --git a/tests/conftest.py b/tests/conftest.py index 28ddfdb..2f815b1 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Pytest fixtures for the REST simulation. Every test that touches engine state runs in an isolated `REST_GAME_DIR` diff --git a/tests/test_distributions.py b/tests/test_distributions.py index 8bd8583..61eb574 100644 --- a/tests/test_distributions.py +++ b/tests/test_distributions.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Sanity-check tests for distribution sampling shape & moments.""" from __future__ import annotations diff --git a/tests/test_economy.py b/tests/test_economy.py index 10f8548..229c205 100644 --- a/tests/test_economy.py +++ b/tests/test_economy.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Unit tests for pure functions in rest_sim.economy.""" from __future__ import annotations diff --git a/tests/test_golden_run.py b/tests/test_golden_run.py index 52bf107..ad99f76 100644 --- a/tests/test_golden_run.py +++ b/tests/test_golden_run.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Golden-run regression test. A 30-day no-decision simulation with a fixed seed must produce a known diff --git a/tests/test_phase2.py b/tests/test_phase2.py index e6c29f9..be10b2d 100644 --- a/tests/test_phase2.py +++ b/tests/test_phase2.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Tests for Phase-2 simulation mechanics: cohorts, reviews, supplier news.""" from __future__ import annotations diff --git a/tests/test_phase4.py b/tests/test_phase4.py index 63d67ab..ccc1c4e 100644 --- a/tests/test_phase4.py +++ b/tests/test_phase4.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Tests for Phase 4 partial-observability layer.""" from __future__ import annotations diff --git a/tests/test_score.py b/tests/test_score.py index 370ac28..1b1699d 100644 --- a/tests/test_score.py +++ b/tests/test_score.py @@ -1,3 +1,7 @@ +# Copyright © 2026 MIH AI B.V. +# Licensed under the Apache License, Version 2.0. +# See LICENSE file in the project root for full license information. + """Tests for the Phase-1 walkout-aware, smooth-penalty score.""" from __future__ import annotations