@mcmcjs/stan 0.1.0

package/LICENSE

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

package/README.md

@@ -0,0 +1,30 @@
+# @mcmcjs/stan
+
+The native Stan engine for [MCMC.js](https://github.com/mcmcjs/mcmcjs).
+
+It resolves a local [CmdStan](https://mc-stan.org/docs/cmdstan-guide/) install, compiles Stan models through CmdStan's make with content-hash caching, and runs NUTS with one process per chain, streaming per-chain progress and draw batches.
+
+## What it provides
+
+- `stanEngine`: the engine descriptor with a `doctor` that reports CmdStan, stanc, make, and the C++ compiler.
+- `runFit(spec, install, io)`: one inference run producing the standard samples file and run record, with `onProgress`/`onDraws` streaming and `AbortSignal` cancellation.
+- `runPredict(spec, install, io)`: posterior prediction via CmdStan `generate_quantities`, replaying a samples file through the model's generated quantities block; `[predict].targets` selects which generated variables to keep.
+- `runMatrix(spec, versions, io)`: the same fit across several installed CmdStan versions, one entry per version (backs `mcmc fit --versions`).
+- `resolveCmdStan(version?)`: finds a CmdStan install; an explicit `MCMCJS_CMDSTAN`/`CMDSTAN` home wins, then the managed root, then `~/.cmdstan` shared with other Stan interfaces.
+- `runSetup(options)`: provisions CmdStan from the official release tarball into the managed root and builds it once.
+- `listVersions()` / `addVersion(version)` / `removeVersion(version)`: manage CmdStan installs under the managed root (backs `mcmc stan version`).
+- `compileModel(install, modelPath)`: the cached model compile, reusable on its own.
+
+## How a fit runs
+
+The spec's canonical data is written to a temp `data.json` (the same JSON a Stan data block reads), one CmdStan process per chain samples with a shared seed and per-chain `id`, progress is parsed from CmdStan's iteration lines, and draws stream by tailing the growing CSVs.
+When all chains finish, the CSVs are combined into the MCMC.js samples format via `@mcmcjs/core`.
+
+## Requirements
+
+CmdStan compiles models with the system toolchain: GNU make and a C++ compiler (g++ or clang++) must be installed.
+`mcmc setup --engine stan` handles the CmdStan side; the compiler comes from your system package manager.
+
+## License
+
+MIT