nagasim 0.6.0__tar.gz

nagasim-0.6.0/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.

nagasim-0.6.0/NOTICE

@@ -0,0 +1,10 @@
+Naga engine
+Copyright (c) 2026 Matteo Brunetti
+
+This product includes software developed by Matteo Brunetti and contributors.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+these files except in compliance with the License. A copy of the License is in
+the LICENSE file next to this notice and at http://www.apache.org/licenses/LICENSE-2.0
+
+Redistributions must retain this NOTICE file (Apache-2.0 section 4(d)). If you
+use the engine in published work, please cite it (see CITATION.cff).

nagasim-0.6.0/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: nagasim
+Version: 0.6.0
+Summary: A simulation engine on SimPy for discrete-event, system-dynamics and agent-based models, with model files, experiments, a twin and agent tools
+Author: Matteo Brunetti
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TheMattHub/naga
+Project-URL: Documentation, https://thematthub.github.io/naga/
+Project-URL: Source, https://github.com/TheMattHub/naga
+Keywords: simulation,discrete-event,system dynamics,agent-based,simpy,digital twin,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Manufacturing
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: simpy<5,>=4.1
+Requires-Dist: numpy>=2.0
+Requires-Dist: pandas>=2.2
+Requires-Dist: scipy>=1.14
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: tzdata>=2024.1; sys_platform == "win32"
+Provides-Extra: plan
+Requires-Dist: ortools>=9.10; extra == "plan"
+Provides-Extra: ml
+Requires-Dist: optuna; extra == "ml"
+Requires-Dist: scikit-learn; extra == "ml"
+Requires-Dist: gymnasium; extra == "ml"
+Provides-Extra: sql
+Requires-Dist: sqlalchemy; extra == "sql"
+Provides-Extra: opcua
+Requires-Dist: asyncua<3,>=2.1; extra == "opcua"
+Provides-Extra: plot
+Requires-Dist: matplotlib; extra == "plot"
+Provides-Extra: mcp
+Requires-Dist: mcp>=1.2; extra == "mcp"
+Provides-Extra: assistant
+Requires-Dist: anthropic>=0.40; extra == "assistant"
+Dynamic: license-file
+
+<p align="center"><img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/banner.svg" alt="Naga: a simulation engine on SimPy" width="820"></p>
+
+<p align="center">
+<a href="https://github.com/TheMattHub/naga/actions/workflows/tests.yml"><img src="https://github.com/TheMattHub/naga/actions/workflows/tests.yml/badge.svg" alt="tests"></a>
+<a href="https://pypi.org/project/nagasim/"><img src="https://img.shields.io/pypi/v/nagasim" alt="PyPI"></a>
+<a href="https://pypi.org/project/nagasim/"><img src="https://img.shields.io/pypi/pyversions/nagasim" alt="Python versions"></a>
+<a href="LICENSE"><img src="https://img.shields.io/badge/licence-Apache--2.0-blue" alt="Apache-2.0"></a>
+</p>
+
+# Naga
+
+Naga is a simulation engine for Python, built on [SimPy](https://simpy.readthedocs.io/), for
+people who have a question about how a system behaves and want an answer they can show their
+work for. You describe the system once, as a data file of blocks, resources and expressions,
+and Naga runs it as a discrete-event, system-dynamics or agent-based model, or as all three on
+one clock. Around each run it puts what turns a single run into evidence: independent
+replications with confidence intervals, scenarios compared on the same random numbers, designed
+experiments, optimisation and calibration. The same model can also be connected to a plant, so
+that it starts from what is happening now, forecasts what comes next, checks those forecasts
+against what then happened, and proposes what to change. Because the model stays a file that
+can be read, compared and shared, whichever way you drive it, the answer it gives is one a team
+can inspect and repeat rather than take on trust.
+
+```console
+pip install nagasim
+naga run single_server --replications 5 --report report.html
+```
+
+Documentation: <https://thematthub.github.io/naga/>
+
+## How it fits together
+
+<p align="center"><img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/overview.svg" alt="What goes into the engine, what it does, and what comes out" width="900"></p>
+
+The picture reads from left to right. On the left is what you bring: a model file, the data
+it draws on and, if you have one, a plant to follow. In the middle the engine runs the model on
+a single clock, whichever of the three ways of modelling it uses, and wraps the run in
+statistics, experiments or a twin. On the right is what comes back: results and a report,
+pages you can send to someone else, and a twin's forecasts and proposals. Along the top are the
+three ways in, the command line, Python and an agent, and because a model is a data file and
+not a program, the same file gives the same answer through each of them.
+
+## What it does
+
+- **Discrete-event models** from blocks (create, process, seize/release, batch, match, decide,
+  route, transport, ...) with resources, sets, schedules, failures, costs, expressions and
+  submodels.
+- **Material handling**: path networks, vehicle fleets with batteries and chargers, conveyors,
+  motion cycles, machine tending.
+- **System dynamics** (stocks, flows, auxiliaries, delays, subscripts, units, XMILE and Vensim
+  import) and **agent-based** models (statecharts, messages, space, networks), in the same model
+  and on the same clock as the discrete-event part.
+- **Statistics you can defend**: independent replications, Student-t intervals, warm-up handling,
+  reproducible random streams, validated against queueing theory.
+- **Experiments**: named scenarios with paired comparisons, design of experiments,
+  ranking-and-selection, optimisation, calibration, forecasting, an investment case.
+- **A twin of a plant** (`naga twin`): live readers for files, SQL, REST, MQTT and OPC UA, a run
+  that starts from the observed state, forecasts scored against what happened, and candidate
+  actions compared on the forecast. It reads a plant and never writes to one.
+- **Model files as data**: a versioned JSON schema, validation with stable problem codes,
+  semantic diff and three-way merge, assertions (`naga check`) with a CI template.
+- **Outputs**: pandas frames, Excel, CSV, JSON, a self-contained HTML report, a recorded run to
+  replay, and a viewer in which the engine itself runs in a browser.
+- **Agent tools**: 68 tools over MCP to build, validate, run, debug and analyse a model.
+
+## Quick start
+
+From the command line, with the bundled example models (`naga examples` lists them; a command
+that takes a model file also takes one of their names):
+
+```console
+naga examples
+naga run single_server --replications 5 --report report.html
+naga scenarios automation_cell
+naga validate single_server
+naga --help
+```
+
+From Python:
+
+```python
+from nagasim import api, examples
+
+results = api.run_model(examples.path("single_server"), replications=5, seed=0)
+print(results["system"])
+```
+
+`results` is a dictionary of pandas frames (system, resources, queues, entities, costs and more).
+
+## What you can see
+
+A run is easier to trust when you can look at it, so the engine writes what it finds as pages
+as well as tables. Each of the four below is a single file, made by one command, that opens in
+a browser with no server behind it: a report to read, a recorded run to replay, a monitor that
+follows a plant, and a viewer in which someone else can change the inputs and run the model
+again. They are what you hand to the people who asked the question.
+
+| | |
+|---|---|
+| <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/charts.png" alt="Charts from the HTML report" width="420"> | <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/player.png" alt="A recorded run in the HTML player" width="420"> |
+| **A report.** `naga run MODEL --report report.html`: KPIs with intervals, resources, costs and charts. | **A recorded run.** `naga run MODEL --player run.html`: the run replayed on the model's layout, with its KPIs. |
+| <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/monitor.png" alt="The twin's monitor page" width="420"> | <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/viewer.png" alt="The viewer: the engine in a browser" width="420"> |
+| **A twin's monitor.** `naga twin run ... --monitor`: the plant now, the forecast against what happened, problems with their hints. The page reloads itself. | **A viewer.** `naga viewer MODEL -o viewer.html`: the engine runs in the reader's browser; they change the inputs you exposed and run it again. |
+
+## Example models
+
+The package holds about fifty models: queues with a known analytical answer, job shops,
+warehouses with forklifts, an energy site, a biogas plant, a supply chain, system-dynamics
+classics, agent-based classics. Each runs as it is, and the documentation has a gallery of them
+with numbers from a run:
+
+```console
+naga run warehouse_forklifts --replications 2
+```
+
+Some of them use submodels that came from asset libraries of a separate product; the engine
+runs the submodels, the product's artwork is not included here.
+
+## Use with an agent
+
+The engine ships 68 tools an agent can call to build, validate, run, debug and analyse a model, and two
+ways to offer them:
+
+<!-- no-run: a server that waits for its client, and a request to a language model -->
+```console
+pip install "nagasim[mcp]"
+naga mcp --root path/to/models                 # an MCP server over stdio (Claude Code, Claude Desktop)
+
+pip install "nagasim[assistant]"               # only for Claude
+naga assist model.json "add a second server"   # one assistant turn on a model file
+```
+
+A local model needs no extra.
+
+`naga assist` talks to a local model by default (an OpenAI-compatible server such as Ollama at
+`http://localhost:11434/v1`; pass its model name with `--model-id`) or to Claude when
+`ANTHROPIC_API_KEY` is set. Where a request goes is the caller's choice and nothing else's:
+command-line flags, then the environment (`NAGASIM_LLM_PROVIDER`, `NAGASIM_LLM_BASE_URL`,
+`NAGASIM_LLM_MODEL`; also `NAGASIM_LLM_API_KEY` and `NAGASIM_LLM_REASONING`), then the defaults.
+`naga mcp` keeps every file inside `--root` and has the network off unless you allow it;
+`naga assist` works on the one model file you give it and reaches only the endpoint you
+configured. A model's own Python behaviour never runs through either.
+
+## Limits to know
+
+- No test has run against a real broker, OPC UA server, MES or plant counter: the readers and
+  the twin are tested on in-process stand-ins and recorded logs.
+- A twin cannot yet start from the state of a model with vehicles or blocking buffers; such a
+  model is monitored and its forecast is refused by name.
+- Recommendations build one action, a resource's capacity, and one sink, a file.
+- The viewer needs Chrome, Edge or Firefox on a desktop.
+- There is no editor and no animation here beyond the recorded player: Naga is an engine.
+
+## Building a product on top
+
+Naga is the engine only. It is written so that a product package (an editor, asset libraries,
+an assistant, connectors) sits beside it and imports it, never the other way round: nothing in
+`nagasim` imports such a package, and a test keeps it that way. Where the code or a comment says
+`product` or "the product", that is the place such a package takes; none is part of this
+repository.
+
+What a product builds on:
+
+- `nagasim.api` (`run_model` and friends) and `nagasim.core.document.ModelDocument`, the model
+  as an editable, undoable document;
+- the model schema (`naga schema`) and structured validation problems with stable codes;
+- the event bus and `nagasim.core.trace.TraceRecorder`, with `nagasim.core.playback.Timeline`
+  to turn a recorded or live run into the state at any instant (what an animation draws);
+- plugin entry points for blocks, distributions and exporters (`nagasim.plugins`);
+- `nagasim.netguard`, the one place file and network access is decided.
+
+## Development
+
+<!-- no-run: installs the package and runs its test suite -->
+```console
+git clone https://github.com/TheMattHub/naga
+cd naga
+pip install -e ".[plan,ml,sql,plot]" -r requirements-dev.txt
+python -m pytest -q -n auto
+```
+
+Python 3.11 or later. The engine depends on SimPy, NumPy, pandas, SciPy and openpyxl; everything
+else is optional and imported only where it is used. The documentation's sources are in `docs/`
+(`pip install -r requirements-docs.txt`, then `python -m mkdocs serve`).
+
+## Versions
+
+Before 1.0:
+
+- Model files always migrate forward: a file saved by an older version opens in a newer one.
+- Agent tool names and problem codes are permanent.
+- The Python API may change between minor versions; every such change has a changelog line.
+
+See the [changelog](CHANGELOG.md).
+
+## Licence and citation
+
+Apache License 2.0, see [LICENSE](LICENSE) and [NOTICE](NOTICE). If you use Naga in published
+work, please cite it: see [CITATION.cff](CITATION.cff).

nagasim-0.6.0/README.md

@@ -0,0 +1,199 @@
+<p align="center"><img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/banner.svg" alt="Naga: a simulation engine on SimPy" width="820"></p>
+
+<p align="center">
+<a href="https://github.com/TheMattHub/naga/actions/workflows/tests.yml"><img src="https://github.com/TheMattHub/naga/actions/workflows/tests.yml/badge.svg" alt="tests"></a>
+<a href="https://pypi.org/project/nagasim/"><img src="https://img.shields.io/pypi/v/nagasim" alt="PyPI"></a>
+<a href="https://pypi.org/project/nagasim/"><img src="https://img.shields.io/pypi/pyversions/nagasim" alt="Python versions"></a>
+<a href="LICENSE"><img src="https://img.shields.io/badge/licence-Apache--2.0-blue" alt="Apache-2.0"></a>
+</p>
+
+# Naga
+
+Naga is a simulation engine for Python, built on [SimPy](https://simpy.readthedocs.io/), for
+people who have a question about how a system behaves and want an answer they can show their
+work for. You describe the system once, as a data file of blocks, resources and expressions,
+and Naga runs it as a discrete-event, system-dynamics or agent-based model, or as all three on
+one clock. Around each run it puts what turns a single run into evidence: independent
+replications with confidence intervals, scenarios compared on the same random numbers, designed
+experiments, optimisation and calibration. The same model can also be connected to a plant, so
+that it starts from what is happening now, forecasts what comes next, checks those forecasts
+against what then happened, and proposes what to change. Because the model stays a file that
+can be read, compared and shared, whichever way you drive it, the answer it gives is one a team
+can inspect and repeat rather than take on trust.
+
+```console
+pip install nagasim
+naga run single_server --replications 5 --report report.html
+```
+
+Documentation: <https://thematthub.github.io/naga/>
+
+## How it fits together
+
+<p align="center"><img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/overview.svg" alt="What goes into the engine, what it does, and what comes out" width="900"></p>
+
+The picture reads from left to right. On the left is what you bring: a model file, the data
+it draws on and, if you have one, a plant to follow. In the middle the engine runs the model on
+a single clock, whichever of the three ways of modelling it uses, and wraps the run in
+statistics, experiments or a twin. On the right is what comes back: results and a report,
+pages you can send to someone else, and a twin's forecasts and proposals. Along the top are the
+three ways in, the command line, Python and an agent, and because a model is a data file and
+not a program, the same file gives the same answer through each of them.
+
+## What it does
+
+- **Discrete-event models** from blocks (create, process, seize/release, batch, match, decide,
+  route, transport, ...) with resources, sets, schedules, failures, costs, expressions and
+  submodels.
+- **Material handling**: path networks, vehicle fleets with batteries and chargers, conveyors,
+  motion cycles, machine tending.
+- **System dynamics** (stocks, flows, auxiliaries, delays, subscripts, units, XMILE and Vensim
+  import) and **agent-based** models (statecharts, messages, space, networks), in the same model
+  and on the same clock as the discrete-event part.
+- **Statistics you can defend**: independent replications, Student-t intervals, warm-up handling,
+  reproducible random streams, validated against queueing theory.
+- **Experiments**: named scenarios with paired comparisons, design of experiments,
+  ranking-and-selection, optimisation, calibration, forecasting, an investment case.
+- **A twin of a plant** (`naga twin`): live readers for files, SQL, REST, MQTT and OPC UA, a run
+  that starts from the observed state, forecasts scored against what happened, and candidate
+  actions compared on the forecast. It reads a plant and never writes to one.
+- **Model files as data**: a versioned JSON schema, validation with stable problem codes,
+  semantic diff and three-way merge, assertions (`naga check`) with a CI template.
+- **Outputs**: pandas frames, Excel, CSV, JSON, a self-contained HTML report, a recorded run to
+  replay, and a viewer in which the engine itself runs in a browser.
+- **Agent tools**: 68 tools over MCP to build, validate, run, debug and analyse a model.
+
+## Quick start
+
+From the command line, with the bundled example models (`naga examples` lists them; a command
+that takes a model file also takes one of their names):
+
+```console
+naga examples
+naga run single_server --replications 5 --report report.html
+naga scenarios automation_cell
+naga validate single_server
+naga --help
+```
+
+From Python:
+
+```python
+from nagasim import api, examples
+
+results = api.run_model(examples.path("single_server"), replications=5, seed=0)
+print(results["system"])
+```
+
+`results` is a dictionary of pandas frames (system, resources, queues, entities, costs and more).
+
+## What you can see
+
+A run is easier to trust when you can look at it, so the engine writes what it finds as pages
+as well as tables. Each of the four below is a single file, made by one command, that opens in
+a browser with no server behind it: a report to read, a recorded run to replay, a monitor that
+follows a plant, and a viewer in which someone else can change the inputs and run the model
+again. They are what you hand to the people who asked the question.
+
+| | |
+|---|---|
+| <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/charts.png" alt="Charts from the HTML report" width="420"> | <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/player.png" alt="A recorded run in the HTML player" width="420"> |
+| **A report.** `naga run MODEL --report report.html`: KPIs with intervals, resources, costs and charts. | **A recorded run.** `naga run MODEL --player run.html`: the run replayed on the model's layout, with its KPIs. |
+| <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/monitor.png" alt="The twin's monitor page" width="420"> | <img src="https://raw.githubusercontent.com/TheMattHub/naga/main/docs/img/shots/viewer.png" alt="The viewer: the engine in a browser" width="420"> |
+| **A twin's monitor.** `naga twin run ... --monitor`: the plant now, the forecast against what happened, problems with their hints. The page reloads itself. | **A viewer.** `naga viewer MODEL -o viewer.html`: the engine runs in the reader's browser; they change the inputs you exposed and run it again. |
+
+## Example models
+
+The package holds about fifty models: queues with a known analytical answer, job shops,
+warehouses with forklifts, an energy site, a biogas plant, a supply chain, system-dynamics
+classics, agent-based classics. Each runs as it is, and the documentation has a gallery of them
+with numbers from a run:
+
+```console
+naga run warehouse_forklifts --replications 2
+```
+
+Some of them use submodels that came from asset libraries of a separate product; the engine
+runs the submodels, the product's artwork is not included here.
+
+## Use with an agent
+
+The engine ships 68 tools an agent can call to build, validate, run, debug and analyse a model, and two
+ways to offer them:
+
+<!-- no-run: a server that waits for its client, and a request to a language model -->
+```console
+pip install "nagasim[mcp]"
+naga mcp --root path/to/models                 # an MCP server over stdio (Claude Code, Claude Desktop)
+
+pip install "nagasim[assistant]"               # only for Claude
+naga assist model.json "add a second server"   # one assistant turn on a model file
+```
+
+A local model needs no extra.
+
+`naga assist` talks to a local model by default (an OpenAI-compatible server such as Ollama at
+`http://localhost:11434/v1`; pass its model name with `--model-id`) or to Claude when
+`ANTHROPIC_API_KEY` is set. Where a request goes is the caller's choice and nothing else's:
+command-line flags, then the environment (`NAGASIM_LLM_PROVIDER`, `NAGASIM_LLM_BASE_URL`,
+`NAGASIM_LLM_MODEL`; also `NAGASIM_LLM_API_KEY` and `NAGASIM_LLM_REASONING`), then the defaults.
+`naga mcp` keeps every file inside `--root` and has the network off unless you allow it;
+`naga assist` works on the one model file you give it and reaches only the endpoint you
+configured. A model's own Python behaviour never runs through either.
+
+## Limits to know
+
+- No test has run against a real broker, OPC UA server, MES or plant counter: the readers and
+  the twin are tested on in-process stand-ins and recorded logs.
+- A twin cannot yet start from the state of a model with vehicles or blocking buffers; such a
+  model is monitored and its forecast is refused by name.
+- Recommendations build one action, a resource's capacity, and one sink, a file.
+- The viewer needs Chrome, Edge or Firefox on a desktop.
+- There is no editor and no animation here beyond the recorded player: Naga is an engine.
+
+## Building a product on top
+
+Naga is the engine only. It is written so that a product package (an editor, asset libraries,
+an assistant, connectors) sits beside it and imports it, never the other way round: nothing in
+`nagasim` imports such a package, and a test keeps it that way. Where the code or a comment says
+`product` or "the product", that is the place such a package takes; none is part of this
+repository.
+
+What a product builds on:
+
+- `nagasim.api` (`run_model` and friends) and `nagasim.core.document.ModelDocument`, the model
+  as an editable, undoable document;
+- the model schema (`naga schema`) and structured validation problems with stable codes;
+- the event bus and `nagasim.core.trace.TraceRecorder`, with `nagasim.core.playback.Timeline`
+  to turn a recorded or live run into the state at any instant (what an animation draws);
+- plugin entry points for blocks, distributions and exporters (`nagasim.plugins`);
+- `nagasim.netguard`, the one place file and network access is decided.
+
+## Development
+
+<!-- no-run: installs the package and runs its test suite -->
+```console
+git clone https://github.com/TheMattHub/naga
+cd naga
+pip install -e ".[plan,ml,sql,plot]" -r requirements-dev.txt
+python -m pytest -q -n auto
+```
+
+Python 3.11 or later. The engine depends on SimPy, NumPy, pandas, SciPy and openpyxl; everything
+else is optional and imported only where it is used. The documentation's sources are in `docs/`
+(`pip install -r requirements-docs.txt`, then `python -m mkdocs serve`).
+
+## Versions
+
+Before 1.0:
+
+- Model files always migrate forward: a file saved by an older version opens in a newer one.
+- Agent tool names and problem codes are permanent.
+- The Python API may change between minor versions; every such change has a changelog line.
+
+See the [changelog](CHANGELOG.md).
+
+## Licence and citation
+
+Apache License 2.0, see [LICENSE](LICENSE) and [NOTICE](NOTICE). If you use Naga in published
+work, please cite it: see [CITATION.cff](CITATION.cff).

nagasim-0.6.0/nagasim/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.0"

nagasim-0.6.0/nagasim/__main__.py

@@ -0,0 +1,3 @@
+from nagasim.cli import main
+
+raise SystemExit(main())