mocaco 0.1.0__tar.gz

mocaco-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run code formatting & linter check (Ruff)
+        run: uv run ruff check .
+
+      - name: Run type check (mypy)
+        run: uv run mypy src/
+
+      - name: Run tests (pytest)
+        run: uv run pytest

mocaco-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,75 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"  # Triggers only when you push a tag like v0.1.0
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI 🧪
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/mocaco
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+      contents: read
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish to PyPI 🚀
+    needs: publish-to-testpypi  # Waits for TestPyPI to succeed first
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mocaco
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+      contents: read
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+          
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

mocaco-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/

mocaco-0.1.0/AGENTS.md

@@ -0,0 +1,11 @@
+# Role
+
+You are an expert python agent aligned with the developer rules of this repository:
+
+1. Read always the contitution.md and the main_spec.md before any modification.
+2. If user mention a task, they are in roadmap.md Only user modify this file. Do not add new points.
+3. Do not commit your modifications. User must review the changes, accept them and commit them. Commit only if user request it explicitly and clearly
+4. Ask any clarification before doing changes if the user do not provide enough instructions.
+5. Despite test are part of the constitution, add them only under user requests
+6. Do not modify the pyproject.toml file except if user request it explicitly.
+7. Run `uv run ruff check --fix . && uv run ruff format .` to verify "All checks passed!" AND `uv run mypy src/` to verify "Sucess: no issues found in..." after each modification.

mocaco-0.1.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to the mocaco project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+- Version bump from `0.1.0` to `1.0.0` in `pyproject.toml`.
+- Updated `docs/index.md` with onboarding contribution section.
+
+### Changed
+- (none for 1.0.0 initial release)
+
+### Deprecated
+- (none for 1.0.0 initial release)
+
+### Fixed
+- (none for 1.0.0 initial release)
+
+## 0.1.0 — 2026-01-01
+
+### Added
+- Initial library structure: `src/mocaco/`, `docs/`, `tests/`, `scripts/`
+- Core convergence criterion: `clt_absolute` — Central Limit Theorem based convergence criterion using an absolute Monte Carlo error threshold
+- Registry auto-discovery pattern — `pkgutil` auto-imports all modules in `src/mocaco/methods/`
+- `ConvergenceResult` abstraction with common fields: `method`, `n`, `estimate`, `error`, `is_converged`, `diagnostics`, `data`
+- Public API: `mcc.samples(df, it_col, target_col)`, `mcc.convergence(samples, method="...")`, `mcc.convergence.clt_absolute(samples, ...)`, `mcc.methods()`, `mcc.describe("name")`
+- Documentation: `constitution.md`, `roadmap.md`, `main_spec.md`, `docs/index.md`, `docs/methods/clt_absolute.md`
+- Test suite foundation: `tests/` with tests for API, registry, protocols, wrappers, results, integration, and methods
+- Project configuration: `pyproject.toml`, `AGENTS.md`, `LICENSE`, `README.md`, `uv.lock`, `.gitignore`
+- Build system: hatchling-based wheel build
+- `# 8. CONTRIBUTING.md Guidelines for external developers registering new convergence criteria.` — New contributing guidelines document at repository root, covering the philosophy of adding only one Python file to register a new convergence criterion, the required file structure (imports, pydantic `params_type`, `@registry.register()` decorator, `run` method), formatting and code quality (ruff, mypy, GitHub Actions), auto-generated documentation, and optional but recommended testing.
+- `# 9. CHANGELOG.md Project Files` — Changelog file created for release notes, following Keep a Changelog format.

mocaco-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,104 @@
+# Contributing to mocaco
+
+## Philosophy
+
+mocaco is an extensible library for convergence analysis of Monte Carlo simulations. It is designed to be easy to use by both users and developers (non-python expert friendly). Adding a new convergence criterion requires **only one Python file** — no changes to the public API, registry, or documentation are needed manually. The project uses an auto-discovery mechanism that process all modules from `src/mocaco/methods/`, so a new criterion is immediately integrated in the library after its module is created.
+
+Friendly remainder: The maintainer (me) is not (yet) a python expert and likely the library can be improved in many ways. If you are a real expert and you desire to pull changes across the libary itself I will be very happy.
+
+## Keep in mind
+
+Each convergence criterion lives as a single module in `src/mocaco/methods/`. The main aspect to remember is that the method will recive a formated polar DataFrame and will return an structured results, including another polar DataFrame. The imput and output data is also explained on this guide as well as the method file structure (see clt_absolute.py method to see an example).
+
+### Input data
+
+The file `src/mocaco/protocols.py` defines the class `SampleFrame` which make sure the input data is standarized. It defines which columns must be used by the method, which will be available for the method. Actually the defined columns names are:
+
+- `df` (pl.DataFrame) Source Polars DataFrame.
+- `it_col` (str) Column containing the iteration/order of the samples.
+- `target_col` (str) Column containing the quantity to analyze.
+
+The file `src/mocaco/protocols.py` also defines the structure of the method, and particularly the run method, which includes:
+
+- `samples` (`SampleFrame`) The structured input
+- `params` The method parameters.
+
+This structure is which allow automatic method discovery and documentation among others. Here data columns are used as `samples.target_col` or `samples.it_col`, while method parameters are used as `params.confidence_level`, for example.
+
+### Output data
+
+The file `src/mocaco/result.py` defines the class `ConvergenceResult`, which contains all the results a method must or can return. See it or see the module clt_absolute.py as a reference. This ensures all methos can be used by the library and be easyly plotted.
+
+## Method structure
+
+Said this, the detailed structure for a new method is as follows:
+
+### 1. Imports and setup
+
+One-line module string description and mandatory basic modules and imports from `mocaco`. Typically includes `polars`, `pydantic`, `scipy.stats`, the `registry`, and `ConvergenceResult`.
+
+### 2. Parameter specification (`params_type`)
+
+A **pydantic `BaseModel`** defines the criterion's input parameters. This is the single source of truth for validation and documentation. Each field must provide:
+
+- Type information
+- Default values if apply
+- Validation constraints (e.g., `gt`, `lt`)
+- Human-readable descriptions
+
+Using pydantic ensures automatic validation, consistent API docs, and generated parameter documentation.
+
+### 3. Criterion class (decorated with `@registry.register()`)
+
+The main class must:
+
+- Assign a stable, concise, lowercase, descriptive `name` (e.g., `"clt_absolute"`)
+- Set `params_type` to the parameter model
+- Optionally set `supports_eval_frequency`
+- Provide documentation sections: `description`, `assumptions`, `limitations`, `result_interpretation`, `example_usage`, `references`
+- Implement a `run(samples, params)` method that returns a `ConvergenceResult`
+
+The `@registry.register()` decorator handles automatic registration — no manual API updates are needed.
+
+### 4. Execution logic (`run` method)
+
+The core convergence computation. Takes a `SampleFrame` and validated `params`, returns a `ConvergenceResult` with the common fields: `method`, `n`, `estimate`, `error`, `is_converged`, `diagnostics`, `data`, among others.
+
+---
+
+## Formatting and code quality
+
+Once a method is created whit the desired structure:
+
+- Run `uv run ruff check --fix . && uv run ruff format .` to ensure Ruff formatting and linting standards.
+- Run `uv run mypy src/` for type checking — all convergence methods must be compatible with the project's strict mypy configuration.
+- GitHub Actions CI runs on every pull request across Python 3.12, 3.13, and 3.14, including ruff, mypy, and pytest.
+
+## Documentation
+
+Documentation is **automatically generated** from the method's parameter specification and class attributes. This is why the following parameters are **mandatory** on every method:
+
+- `params_type` — pydantic BaseModel; its fields are the single source of truth for validation and docs
+- `name` — stable identifier, used in API endpoints and documentation
+- `assumptions` — explicitly documented statistical assumptions (i.i.d., finite variance, CLT applicability, etc.)
+- `limitations` — what the criterion does not guarantee
+- `result_interpretation` — explanation of each `ConvergenceResult` field
+- `example_usage` — minimal working example
+- `references` — academic citations where applicable
+
+The `docs/index.md` and method docs in `docs/methods/` are regenerated by running `uv run python scripts/generate_docs.py`. 
+
+## Testing
+
+Tests are **optional but highly recommended**. A new criterion should include tests covering:
+
+- Valid inputs
+- Invalid parameters
+- Edge cases
+- Expected convergence behavior
+- Expected non-convergence behavior
+- Result structure
+
+If tests are not provided, the maintainer will likely contact the contributor to clarify doubts and add the required test coverage before merging.
+
+---

mocaco-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

mocaco-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.5
+Name: mocaco
+Version: 0.1.0
+Summary: Convergence analysis for Monte Carlo series — works with Polars DataFrames
+Author-email: Álvaro Esteban Muñoz <em.alvaro.l@gmail.com>
+License: LGPL-3.0-or-later
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: matplotlib>=3.11.2
+Requires-Dist: numpy>=2.5.3
+Requires-Dist: pandas>=3.0.6
+Requires-Dist: polars>=1.44.2
+Requires-Dist: pyarrow>=25.0.1
+Requires-Dist: pydantic>=2.13.5
+Requires-Dist: rich>=15.0.0
+Requires-Dist: scipy>=1.18.1
+Description-Content-Type: text/markdown
+
+# mocaco
+
+[![CI](https://github.com/emalvarol/mocaco/actions/workflows/ci.yml/badge.svg)](https://github.com/emalvarol/mocaco/actions/workflows/ci.yml)
+![Python Versions](https://img.shields.io/badge/python-3.12%20|%203.13%20|%203.14-blue)
+![License: LGPL](https://img.shields.io/badge/license-LGPL-blue)
+
+Convergence analysis for Monte Carlo series using Polars DataFrames.
+
+<p align="center">
+  <img src="assets/Logo_v1.png" alt="mocaco logo" width="400"/>
+</p>
+
+The library provides a simple API for applying different convergence and
+stopping criteria to Monte Carlo simulation results.
+
+## Quickstart
+
+```python
+import polars as pl
+import mocaco as mcc
+
+# Prepare your Monte Carlo samples
+df = pl.DataFrame({"it": range(1000), "value": your_samples})
+
+# Create a normalized sample frame
+samples = mcc.samples(df, it_col="it", target_col="value")
+
+# Run a convergence criterion
+result = mcc.convergence.clt_absolute(samples, threshold=0.01)
+
+# Inspect results
+print(result.is_converged)  # True/False
+print(result.estimate)  # Final cumulative mean
+print(result.error)  # Final CLT-based absolute error
+print(result.n)  # Number of samples
+# and more...
+```
+
+## API Overview
+
+| Function | Description |
+|----------|-------------|
+| `mcc.samples(df, it_col, target_col)` | Create a normalized sample frame from a Polars DataFrame |
+| `mcc.convergence(samples, method="...")` | Generic invocation of any registered criterion |
+| `mcc.convergence.clt_absolute(samples, ...)` | Typed invocation of a specific criterion |
+| `mcc.methods()` | List all registered convergence criteria |
+| `mcc.describe("clt_absolute")` | Get metadata and parameter info for a criterion |
+
+## Available Methods
+
+- [`clt_absolute`](docs/methods/clt_absolute.md) — CLT-based absolute error threshold
+
+## Documentation
+
+Full documentation is available in the `docs/` directory or can be built with:
+
+```bash
+mkdocs serve
+```
+
+## Installation (Developers)
+
+### Environment
+
+Create the virtual environment and install the project in editable mode with `uv`:
+
+```bash
+uv venv
+uv sync
+uv pip install -e .
+```
+
+If it is needed to remove an old environment:
+
+```bash
+Remove-Item -Recurse -Force .venv
+```
+
+### ruff
+```bash
+uv run ruff check --fix . && uv run ruff format .
+```
+
+### mypy
+```bash
+uv run mypy src/
+```

mocaco-0.1.0/README.md

@@ -0,0 +1,87 @@
+# mocaco
+
+[![CI](https://github.com/emalvarol/mocaco/actions/workflows/ci.yml/badge.svg)](https://github.com/emalvarol/mocaco/actions/workflows/ci.yml)
+![Python Versions](https://img.shields.io/badge/python-3.12%20|%203.13%20|%203.14-blue)
+![License: LGPL](https://img.shields.io/badge/license-LGPL-blue)
+
+Convergence analysis for Monte Carlo series using Polars DataFrames.
+
+<p align="center">
+  <img src="assets/Logo_v1.png" alt="mocaco logo" width="400"/>
+</p>
+
+The library provides a simple API for applying different convergence and
+stopping criteria to Monte Carlo simulation results.
+
+## Quickstart
+
+```python
+import polars as pl
+import mocaco as mcc
+
+# Prepare your Monte Carlo samples
+df = pl.DataFrame({"it": range(1000), "value": your_samples})
+
+# Create a normalized sample frame
+samples = mcc.samples(df, it_col="it", target_col="value")
+
+# Run a convergence criterion
+result = mcc.convergence.clt_absolute(samples, threshold=0.01)
+
+# Inspect results
+print(result.is_converged)  # True/False
+print(result.estimate)  # Final cumulative mean
+print(result.error)  # Final CLT-based absolute error
+print(result.n)  # Number of samples
+# and more...
+```
+
+## API Overview
+
+| Function | Description |
+|----------|-------------|
+| `mcc.samples(df, it_col, target_col)` | Create a normalized sample frame from a Polars DataFrame |
+| `mcc.convergence(samples, method="...")` | Generic invocation of any registered criterion |
+| `mcc.convergence.clt_absolute(samples, ...)` | Typed invocation of a specific criterion |
+| `mcc.methods()` | List all registered convergence criteria |
+| `mcc.describe("clt_absolute")` | Get metadata and parameter info for a criterion |
+
+## Available Methods
+
+- [`clt_absolute`](docs/methods/clt_absolute.md) — CLT-based absolute error threshold
+
+## Documentation
+
+Full documentation is available in the `docs/` directory or can be built with:
+
+```bash
+mkdocs serve
+```
+
+## Installation (Developers)
+
+### Environment
+
+Create the virtual environment and install the project in editable mode with `uv`:
+
+```bash
+uv venv
+uv sync
+uv pip install -e .
+```
+
+If it is needed to remove an old environment:
+
+```bash
+Remove-Item -Recurse -Force .venv
+```
+
+### ruff
+```bash
+uv run ruff check --fix . && uv run ruff format .
+```
+
+### mypy
+```bash
+uv run mypy src/
+```