drisk 0.1.0__tar.gz

drisk-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Quarto-generated files
+docs/_site/
+docs/.quarto/
+docs/objects.json
+docs/reference/
+
+# Virtual environments
+.venv

drisk-0.1.0/LICENSE

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

drisk-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: drisk
+Version: 0.1.0
+Summary: Composable tools for quick Monte Carlo modelling and distribution elicitation.
+Project-URL: Documentation, https://nick-dorsch.github.io/drisk/
+Project-URL: Repository, https://github.com/nick-dorsch/drisk
+Project-URL: Issues, https://github.com/nick-dorsch/drisk/issues
+Author: Nicholas Dorsch
+License: MIT
+License-File: LICENSE
+Keywords: distributions,elicitation,monte-carlo,probability,simulation,uncertainty
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.12
+Requires-Dist: matplotlib>=3.11.0
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: pandas>=3.0.3
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: scipy>=1.17.1
+Description-Content-Type: text/markdown
+
+# drisk
+
+Composable tools for quick Monte Carlo modelling, with an emphasis on distribution
+elicitation and model composition.
+
+`drisk` provides a compact, notebook-friendly API for probability distributions,
+elicitation workflows, correlated sampling, decision trees, sensitivity analysis, and
+composable Monte Carlo models.
+
+> `drisk` is currently in alpha. APIs may change before a stable release.
+
+## Links
+
+- Documentation: <https://nick-dorsch.github.io/drisk/>
+- Repository: <https://github.com/nick-dorsch/drisk>
+- Issues: <https://github.com/nick-dorsch/drisk/issues>
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install drisk
+```
+
+Or with `uv`:
+
+```bash
+uv add drisk
+```
+
+`drisk` requires Python 3.12 or newer.
+
+## Quick start
+
+```python
+import drisk as dr
+
+# Elicit a distribution from intuitive inputs.
+dist = dr.LogitNormal.elicit(low=0.1, high=0.25)
+
+# Draw Monte Carlo samples.
+samples = dist.sample(1_000)
+```
+
+## Features
+
+- Continuous distributions such as `Normal`, `LogNormal`, `LogitNormal`, `Beta`, `PERT`, `Gamma`, and `Exponential`
+- Discrete distributions such as `Bernoulli`, `Binomial`, `Poisson`, `Geometric`, and `NegativeBinomial`
+- Distribution elicitation, fitting, sampling, plotting, and serialization-friendly parameters
+- Mixture distributions with `UvMixture`
+- Correlation matrix helpers and Gaussian / Student-t copulas
+- Composable Monte Carlo models via `MCModel`, `MCOperation`, and `where`
+- Decision tree modelling with chance, decision, and outcome nodes
+- One-at-a-time sensitivity analysis helpers
+
+## Documentation
+
+The documentation site includes examples and API reference pages:
+
+<https://nick-dorsch.github.io/drisk/>
+
+## Developer setup
+
+This repository uses:
+
+- [mise](https://mise.jdx.dev/) to install local development tools and run common project tasks
+- [uv](https://docs.astral.sh/uv/) for Python dependency management and command execution
+
+### 1. Install tools with mise
+
+Install `mise` if you do not already have it, then install the tools pinned in
+`.mise.toml`:
+
+```bash
+mise install
+```
+
+This installs the project Python version, `uv`, `ruff`, and other helper tools for the
+repository.
+
+### 2. Install Python dependencies with uv
+
+Sync the project environment from `pyproject.toml` and `uv.lock`:
+
+```bash
+uv sync --all-groups
+```
+
+Use `uv run ...` for commands that should execute inside the managed environment:
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run python -c "import drisk as dr; print(dr.Normal.elicit(0, 1))"
+```
+
+When adding dependencies, use `uv add` so `pyproject.toml` and `uv.lock` stay in sync:
+
+```bash
+uv add numpy
+uv add --dev pytest
+uv add --group docs jupyter
+```
+
+### 3. Run project tasks with mise
+
+List available tasks:
+
+```bash
+mise tasks
+```
+
+Common tasks:
+
+```bash
+mise run test      # run the test suite
+mise run lint      # run ruff checks
+mise run format    # format the codebase
+mise run check     # run lint and tests
+mise run docs      # preview the Quarto documentation site
+```
+
+## Project layout
+
+```text
+src/drisk/
+  copulas/                  # copula interfaces and implementations
+  correlations/             # correlation matrix helpers
+  decision/                 # decision tree nodes, branches, and trees
+  distributions/            # distribution interfaces and implementations
+  models/                   # composable Monte Carlo model helpers
+  sensitivity/              # sensitivity analysis utilities
+  arithmetic.py             # arithmetic/composition helpers
+  random.py                 # seed/RNG helpers
+  summary.py                # summary helpers
+
+tests/                      # pytest suite
+docs/                       # Quarto documentation site
+```
+
+## License
+
+`drisk` is distributed under the MIT License. See [LICENSE](LICENSE) for details.

drisk-0.1.0/README.md

@@ -0,0 +1,144 @@
+# drisk
+
+Composable tools for quick Monte Carlo modelling, with an emphasis on distribution
+elicitation and model composition.
+
+`drisk` provides a compact, notebook-friendly API for probability distributions,
+elicitation workflows, correlated sampling, decision trees, sensitivity analysis, and
+composable Monte Carlo models.
+
+> `drisk` is currently in alpha. APIs may change before a stable release.
+
+## Links
+
+- Documentation: <https://nick-dorsch.github.io/drisk/>
+- Repository: <https://github.com/nick-dorsch/drisk>
+- Issues: <https://github.com/nick-dorsch/drisk/issues>
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install drisk
+```
+
+Or with `uv`:
+
+```bash
+uv add drisk
+```
+
+`drisk` requires Python 3.12 or newer.
+
+## Quick start
+
+```python
+import drisk as dr
+
+# Elicit a distribution from intuitive inputs.
+dist = dr.LogitNormal.elicit(low=0.1, high=0.25)
+
+# Draw Monte Carlo samples.
+samples = dist.sample(1_000)
+```
+
+## Features
+
+- Continuous distributions such as `Normal`, `LogNormal`, `LogitNormal`, `Beta`, `PERT`, `Gamma`, and `Exponential`
+- Discrete distributions such as `Bernoulli`, `Binomial`, `Poisson`, `Geometric`, and `NegativeBinomial`
+- Distribution elicitation, fitting, sampling, plotting, and serialization-friendly parameters
+- Mixture distributions with `UvMixture`
+- Correlation matrix helpers and Gaussian / Student-t copulas
+- Composable Monte Carlo models via `MCModel`, `MCOperation`, and `where`
+- Decision tree modelling with chance, decision, and outcome nodes
+- One-at-a-time sensitivity analysis helpers
+
+## Documentation
+
+The documentation site includes examples and API reference pages:
+
+<https://nick-dorsch.github.io/drisk/>
+
+## Developer setup
+
+This repository uses:
+
+- [mise](https://mise.jdx.dev/) to install local development tools and run common project tasks
+- [uv](https://docs.astral.sh/uv/) for Python dependency management and command execution
+
+### 1. Install tools with mise
+
+Install `mise` if you do not already have it, then install the tools pinned in
+`.mise.toml`:
+
+```bash
+mise install
+```
+
+This installs the project Python version, `uv`, `ruff`, and other helper tools for the
+repository.
+
+### 2. Install Python dependencies with uv
+
+Sync the project environment from `pyproject.toml` and `uv.lock`:
+
+```bash
+uv sync --all-groups
+```
+
+Use `uv run ...` for commands that should execute inside the managed environment:
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run python -c "import drisk as dr; print(dr.Normal.elicit(0, 1))"
+```
+
+When adding dependencies, use `uv add` so `pyproject.toml` and `uv.lock` stay in sync:
+
+```bash
+uv add numpy
+uv add --dev pytest
+uv add --group docs jupyter
+```
+
+### 3. Run project tasks with mise
+
+List available tasks:
+
+```bash
+mise tasks
+```
+
+Common tasks:
+
+```bash
+mise run test      # run the test suite
+mise run lint      # run ruff checks
+mise run format    # format the codebase
+mise run check     # run lint and tests
+mise run docs      # preview the Quarto documentation site
+```
+
+## Project layout
+
+```text
+src/drisk/
+  copulas/                  # copula interfaces and implementations
+  correlations/             # correlation matrix helpers
+  decision/                 # decision tree nodes, branches, and trees
+  distributions/            # distribution interfaces and implementations
+  models/                   # composable Monte Carlo model helpers
+  sensitivity/              # sensitivity analysis utilities
+  arithmetic.py             # arithmetic/composition helpers
+  random.py                 # seed/RNG helpers
+  summary.py                # summary helpers
+
+tests/                      # pytest suite
+docs/                       # Quarto documentation site
+```
+
+## License
+
+`drisk` is distributed under the MIT License. See [LICENSE](LICENSE) for details.

drisk-0.1.0/pyproject.toml

@@ -0,0 +1,91 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "drisk"
+version = "0.1.0"
+description = "Composable tools for quick Monte Carlo modelling and distribution elicitation."
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [
+    { name = "Nicholas Dorsch" },
+]
+license = { text = "MIT" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Mathematics",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+keywords = [
+    "monte-carlo",
+    "simulation",
+    "probability",
+    "distributions",
+    "elicitation",
+    "uncertainty",
+]
+
+dependencies = [
+    "matplotlib>=3.11.0",
+    "numpy>=2.2.4",
+    "pandas>=3.0.3",
+    "pydantic>=2.13.4",
+    "scipy>=1.17.1",
+]
+
+[project.urls]
+Documentation = "https://nick-dorsch.github.io/drisk/"
+Repository = "https://github.com/nick-dorsch/drisk"
+Issues = "https://github.com/nick-dorsch/drisk/issues"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.19.1",
+    "pytest>=9.0.2",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.14.14",
+]
+docs = [
+    "ipykernel>=7.3.0",
+    "jupyter>=1.1.1",
+    "nbclient>=0.11.0",
+    "pyyaml>=6.0.3",
+    "quartodoc>=0.9.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/drisk"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+    "/pyproject.toml",
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "C4", "UP", "PT", "SIM"]
+ignore = [
+    "B008",
+    "E501",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

drisk-0.1.0/src/drisk/__init__.py

@@ -0,0 +1,89 @@
+"""Convenient tools for quick Monte Carlo modelling."""
+
+from . import _style as _style
+from .copulas import Copula, GaussianCopula, StudentTCopula
+from .correlations import CorrelationMatrix
+from .decision import (
+    ChanceBranch,
+    ChanceNode,
+    DecisionBranch,
+    DecisionNode,
+    DTree,
+    DTreeNode,
+    OutcomeNode,
+)
+from .distributions import (
+    PERT,
+    ArrayLike,
+    Bernoulli,
+    Beta,
+    Binomial,
+    DataFrameLike,
+    Distribution,
+    Exponential,
+    Gamma,
+    Geometric,
+    LogitNormal,
+    LogNormal,
+    NegativeBinomial,
+    Normal,
+    Poisson,
+    StretchedBeta,
+    UvBoundedContinuous,
+    UvContinuous,
+    UvCountDiscrete,
+    UvDiscrete,
+    UvDistribution,
+    UvFiniteDiscrete,
+    UvMixture,
+    UvPositiveContinuous,
+    UvRealContinuous,
+    UvUnitBoundedContinuous,
+)
+from .models import MCModel, MCOperation, where
+from .sensitivity import OneAtATimeSensitivity, one_at_a_time
+
+__all__ = [
+    "ArrayLike",
+    "Bernoulli",
+    "Beta",
+    "Binomial",
+    "ChanceBranch",
+    "ChanceNode",
+    "Copula",
+    "CorrelationMatrix",
+    "DataFrameLike",
+    "DecisionBranch",
+    "DecisionNode",
+    "Distribution",
+    "DTree",
+    "DTreeNode",
+    "Exponential",
+    "GaussianCopula",
+    "Gamma",
+    "Geometric",
+    "LogitNormal",
+    "MCModel",
+    "MCOperation",
+    "LogNormal",
+    "UvMixture",
+    "NegativeBinomial",
+    "Normal",
+    "OneAtATimeSensitivity",
+    "OutcomeNode",
+    "one_at_a_time",
+    "PERT",
+    "Poisson",
+    "StudentTCopula",
+    "StretchedBeta",
+    "UvBoundedContinuous",
+    "UvContinuous",
+    "UvCountDiscrete",
+    "UvDiscrete",
+    "UvDistribution",
+    "UvFiniteDiscrete",
+    "UvPositiveContinuous",
+    "UvRealContinuous",
+    "UvUnitBoundedContinuous",
+    "where",
+]

drisk-0.1.0/src/drisk/_style.py

@@ -0,0 +1,5 @@
+"""Package-wide Matplotlib defaults."""
+
+import matplotlib as mpl
+
+mpl.rcParams.update({"axes.grid": True, "grid.alpha": 0.25})

drisk-0.1.0/src/drisk/arithmetic.py

@@ -0,0 +1,111 @@
+"""Arithmetic helpers for composable Monte Carlo expressions."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class ArithmeticMixin:
+    """Mixin that turns arithmetic into lazy Monte Carlo model expressions."""
+
+    def __add__(self, other: Any) -> Any:
+        """Create a lazy model for ``self + other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.ADD, self, other)
+
+    def __radd__(self, other: Any) -> Any:
+        """Create a lazy model for ``other + self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.ADD, other, self)
+
+    def __sub__(self, other: Any) -> Any:
+        """Create a lazy model for ``self - other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.SUBTRACT, self, other)
+
+    def __rsub__(self, other: Any) -> Any:
+        """Create a lazy model for ``other - self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.SUBTRACT, other, self)
+
+    def __mul__(self, other: Any) -> Any:
+        """Create a lazy model for ``self * other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.MULTIPLY, self, other)
+
+    def __rmul__(self, other: Any) -> Any:
+        """Create a lazy model for ``other * self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.MULTIPLY, other, self)
+
+    def __truediv__(self, other: Any) -> Any:
+        """Create a lazy model for ``self / other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.DIVIDE, self, other)
+
+    def __rtruediv__(self, other: Any) -> Any:
+        """Create a lazy model for ``other / self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.DIVIDE, other, self)
+
+    def __pow__(self, other: Any) -> Any:
+        """Create a lazy model for ``self ** other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.POWER, self, other)
+
+    def __rpow__(self, other: Any) -> Any:
+        """Create a lazy model for ``other ** self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.POWER, other, self)
+
+    def __lt__(self, other: Any) -> Any:
+        """Create a lazy model for ``self < other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.LESS, self, other)
+
+    def __le__(self, other: Any) -> Any:
+        """Create a lazy model for ``self <= other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.LESS_EQUAL, self, other)
+
+    def __gt__(self, other: Any) -> Any:
+        """Create a lazy model for ``self > other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.GREATER, self, other)
+
+    def __ge__(self, other: Any) -> Any:
+        """Create a lazy model for ``self >= other``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.GREATER_EQUAL, self, other)
+
+    def __neg__(self) -> Any:
+        """Create a lazy model for ``-self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.NEGATIVE, self)
+
+    def __pos__(self) -> Any:
+        """Create a lazy model for ``+self``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.POSITIVE, self)
+
+    def __abs__(self) -> Any:
+        """Create a lazy model for ``abs(self)``."""
+        from drisk.models import MCModel, MCOperation
+
+        return MCModel.from_operation(MCOperation.ABS, self)

drisk-0.1.0/src/drisk/copulas/__init__.py

@@ -0,0 +1,7 @@
+"""Copula models for jointly sampling marginal distributions."""
+
+from .base import Copula
+from .gaussian import GaussianCopula
+from .student_t import StudentTCopula
+
+__all__ = ["Copula", "GaussianCopula", "StudentTCopula"]