openreynolds 0.1.0__tar.gz

openreynolds-0.1.0/.gitattributes

@@ -0,0 +1,4 @@
+* text=auto eol=lf
+*.png binary
+*.jpg binary
+*.stl binary

openreynolds-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+# credentials — never commit these
+.foamd_key
+.env
+*.key
+
+# local study mirror
+studies/
+
+# python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+user-test*.log
+
+# editor/agent scratch
+.claude/

openreynolds-0.1.0/CHANGELOG.md

@@ -0,0 +1,80 @@
+# Changelog
+
+All notable changes to this project are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-08-27
+
+The first release: the tool-use loop over a hosted OpenFOAM workspace, seven tools, the
+terminal interface, watch mode with factual wakes, the local study mirror, capture,
+stopping that verifies, the toolbox and the field notes -- and, since the first cut
+on 2026-08-24:
+
+### Added
+
+- An npm launcher (`launcher/`, published as `openreynolds`): `npm install -g
+  openreynolds` finds or installs `uv`, installs the Python package from PyPI once,
+  and runs it. No Python source ships in the npm tarball.
+- `openreynolds login`: sign in from the terminal by approving a short code in the
+  browser; the service key lands in the config file. The service has a default address
+  now (`https://api.tryreynolds.com`), so a fresh install needs no URL.
+- Bring your own model, not just your own key: `OPENREYNOLDS_PROVIDER` /
+  `openreynolds config --provider` pick Anthropic, OpenAI, Z.ai, DeepSeek, Moonshot,
+  MiniMax, OpenRouter or a local Ollama, or any endpoint speaking the Messages API or
+  Chat Completions (`openreynolds/llm/`). `ANTHROPIC_API_KEY` still works; the general
+  name is `OPENREYNOLDS_LLM_API_KEY`, and older config files are read as before.
+- A live mirror: the study's files are synced to `./studies/<id>/files/` in the
+  background for the whole session, and a render the model just looked at arrives at
+  once. The interface's files pane reads from it.
+- A progress bar for real compute -- solver time against `endTime`, residuals, Courant
+  number, snappyHexMesh phase -- shown only while a solve, mesh, decomposition or sync
+  is running.
+- A front desk: a second, cheap agent that answers the user within seconds while the
+  main agent is mid-turn, and writes the plain-language "now" line. It is read-only
+  and cannot steer the agent. `OPENREYNOLDS_DESK=0` turns it off.
+- Render delivery: every image the instance writes lands in a flat
+  `./studies/<id>/renders/` folder, frame directories are assembled into gifs locally,
+  and the interface has a renders tab. `openreynolds renders` lists them.
+- `openreynolds video` encodes a frame set on the user's machine (ffmpeg, or imageio as
+  a fallback); the instance never carries an encoder.
+- `openreynolds push` carries a local file or directory up to the study's workspace.
+- `job_check` takes `wait_s`, holding the answer until the job ends or the user types.
+- `python -m openreynolds` as an entry point beside the console script.
+- `cli.session(..., interface=)`: a seam through which another interface (a web page,
+  a test harness) can drive a session using the same `View` the terminal uses.
+- `-p` runs exit `1` when the model API would not complete a turn and `2` when
+  `--max-wait` ran out with a job still running, so a script can tell the two apart
+  from a run that finished.
+- `OPENREYNOLDS_CAPTURE=0` switches transcript upload off from the environment; the
+  README says up front that transcripts go to the workspace service by default.
+- Packaging metadata: project URLs, authorship, keywords, classifiers, a PEP 639
+  licence expression, the version read from the package, `video` and `toolbox`
+  extras, and an sdist that leaves study mirrors and engineering scaffolding behind.
+  CI runs on Windows and Python 3.11 as well.
+- `SECURITY.md`, `CONTRIBUTING.md` and this changelog.
+
+### Changed
+
+- Turn-end syncs no longer block the session thread; the mirror is poked instead, so a
+  message typed during a long solve is read at once.
+- After two model-API failures in a row the session says plainly what is happening and
+  how to resume, instead of repeating that the thread is intact.
+- The thread sheds the pixels of images the model has already looked at, keeping the
+  path and description, so long render-and-look sessions stay a size the API accepts.
+- Field notes: steady-versus-transient, the 2D recipe, `job_check wait_s` in place of
+  `sleep`, rendering next to the data, and what a steady solve that will not converge
+  usually means.
+- The design document moved to `docs/design.md`.
+
+### Fixed
+
+- `openreynolds doctor` opened a real study on the platform every run to check that
+  capture worked. It now makes a read-only call and changes nothing.
+- A duplicate copy of the architecture notes at the repository root is gone; the one
+  under the toolbox notes is the one that ships.
+
+[Unreleased]: https://github.com/InviscidAI/OpenReynolds/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/InviscidAI/OpenReynolds/releases/tag/v0.1.0

openreynolds-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contributing
+
+## Setting up
+
+```bash
+git clone https://github.com/InviscidAI/OpenReynolds
+cd OpenReynolds
+pip install -e ".[dev]"
+python -m pytest tests -q
+git config core.hooksPath .githooks
+```
+
+The last line installs the pre-commit hook, which runs the whole suite before a commit
+is allowed. It takes about half a minute. It exists because twice in one session a
+commit went out red on the strength of the tests just written rather than the whole
+suite, and discipline had already failed twice.
+
+The suite runs against fakes -- no service account, no model key, no network. The
+scripts under `scripts/` drive a live service and need credentials; `openreynolds doctor`
+says whether yours work.
+
+## The tests that will bite
+
+A good part of the suite checks the *shape* of the code rather than its behaviour.
+These are the ones a reasonable change trips over, and what each one wants:
+
+- **Everything declared is read** (`tests/test_wiring.py`). Every click option, every
+  `Config` field, every `ToolContext` field, every `View` method and every `Backend`
+  method has to be read somewhere in the package. Four separate times something was
+  defined, documented, listed in `--help` and never wired up; the test turns that into
+  a failure. Adding a field means wiring it end to end in the same change.
+- **The README mentions every subcommand** (`tests/test_wiring.py`). A command nobody
+  is told about is a command nobody uses. A new `@main.command("x")` needs the string
+  `openreynolds x` in the README.
+- **Documents carry no hand-edited test counts** (`tests/test_wiring.py`). A number
+  that has to be edited by hand goes stale.
+- **No imperative language in the system prompt or the briefing**
+  (`tests/test_prompt.py`, `tests/test_briefing.py`). "Always", "you should", "make
+  sure", "first,", "workflow" and their relatives fail the build. The prompt states
+  facts; decisions are the model's. Know-how belongs in the toolbox and the field
+  notes, where it is offered rather than imposed. The system prompt is also
+  byte-frozen (it is the cache prefix) and capped in length, so it changes rarely and
+  deliberately.
+- **HTTP stays below the backend protocol** (`tests/test_negative_obligation.py`).
+  `openreynolds/backend/hosted.py` is the only module that knows a service exists.
+  Nothing above `backend/base.py` may import a transport or mention an endpoint.
+
+The contract these tests enforce is in [`docs/design.md`](docs/design.md): the harness
+may cap output, sync the toolbox, poll jobs and wake the model with facts, and capture
+the transcript. It may not order the model's actions, gate or rewrite a tool call,
+require approvals, inject checklists, or grade the output.
+
+## Style
+
+- Docstrings explain *why*, often with the incident that taught it.
+  [`docs/found-by-using-it.md`](docs/found-by-using-it.md) is the casebook; a fix that
+  came from using the thing usually earns an entry there.
+- Commit messages are a sentence about what is now true, in the style of `git log`.
+- Files are UTF-8. Git normalises line endings to LF (`.gitattributes`); on Windows the
+  working copies are typically CRLF, and an editor that rewrites a whole file's endings
+  makes a diff nobody can review -- keep each file the way you found it.
+- Tests are named for the behaviour they protect (`test_a_failed_turn_does_not_...`),
+  and a test that exists because something went wrong says so in its docstring.
+
+## Sending a change
+
+Open a pull request against `main` with the suite green. Say what is now true that was
+not before, and if the change came from a session that went wrong, what happened. A
+change to the prompt, the briefing or the tool schemas is a change to what the model
+sees and gets a closer look than the rest.

openreynolds-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 InviscidAI
+
+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.