vates 0.1.0__tar.gz

vates-0.1.0/LICENSE

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

vates-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: vates
+Version: 0.1.0
+Summary: Python actuarial model
+Author-email: Shanya Shi <shanyashi2025@gmail.com>
+License: MIT
+Keywords: actuarial model,asset-liability model,alm
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: pandas<3.0.0,>=2.3.0
+Requires-Dist: scipy
+Dynamic: license-file
+
+# Vates Project
+
+Open-source Python framework and sample implementations for actuarial modeling.
+
+### How this repo is organized
+
+1. **`vates/`** — The **standard** library / installable package: reusable framework code (`pip install -e .`).
+2. **`examples/model/`** — **Example / tutorial for model developers** (company builders): reference models (`fund_model.py`, `port_monte_carlo.py`) and local package(s) (`local_package/`).
+3. **Other folders under `examples/`** (`scripts/`, `cli/`, `input/`, …) — **Example / tutorial for most colleagues**: how to run models for analysis and reporting (commands, sample data), without editing framework or model code.
+4. The **`gui/`** app is another way for analysts to run tasks.
+
+## Install the framework (`vates`)
+
+Work from the **repository root**.
+
+### 1. Create a virtual environment (recommended)
+
+**PowerShell** (Windows):
+
+```powershell
+cd path\to\your\project
+python -m venv .venv
+.venv\Scripts\Activate.ps1
+```
+
+If activation is blocked by execution policy, run once in that window:
+
+```powershell
+Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
+```
+
+Then run `Activate.ps1` again.
+
+**Command Prompt** (`cmd.exe`):
+
+```bat
+cd path\to\your\project
+python -m venv .venv
+.venv\Scripts\activate.bat
+```
+
+You should see `(.venv)` in the prompt when the environment is active.
+
+### 2. Install `vates` in editable mode
+
+```powershell
+pip install -e .
+```
+
+This installs the distribution **`vates`** in editable mode; import the library as **`import vates`**.
+
+## Project layout
+
+| Path                | Role                                             |
+|---------------------|--------------------------------------------------|
+| `vates/`            | Core framework and library (`pip install -e .`). |
+| `examples/model/`   | Reference models and company-style package(s).   |
+| `examples/scripts/` | Python scripts that call the reference models.   |
+| `examples/cli/`     | CLI commands and model args json files.          |
+| `examples/input/`   | Sample CSV input data.                           |
+| `gui/`              | End-user launcher.                               |
+| `docs/`             | Structure notes and discussions.                 |
+
+
+## Quick start
+
+### 1) Example Models
+
+| No | Example Model         | Python Script                            | CLI + json                  |
+|----|-----------------------|------------------------------------------|-----------------------------|
+| 1  | 01_asset_proj         | `python .\examples\scripts\script_01.py` | `.\examples\cli\cli_01.bat` |
+| 2  | 02_fund_proj          | `python .\examples\scripts\script_02.py` | `.\examples\cli\cli_02.bat` |
+| 3  | 03_cross_proj         | `python .\examples\scripts\script_11.py` | `.\examples\cli\cli_11.bat` |
+| 5  | 21_smith_wilson       | `python .\examples\scripts\script_21.py` | `.\examples\cli\cli_21.bat` |
+
+
+- Model output can be found in `.\examples\results\script_*` and/or `.\examples\results\cli_*`
+- CLI is configured via the corresponding json file `.\examples\cli\model_args_*.json`.
+
+
+### 2) GUI
+
+Start GUI:
+```powershell
+.\gui\start.bat
+```
+
+## For model developers
+
+- Treat **`examples/model/`** as a **reference** layout: copy `local_package/` (rename to your company package) and the model files into your own repository.
+- Keep company-specific code **outside** `vates/`; depend on **`vates`** via `pip install` or your dependency mechanism.

vates-0.1.0/README.md

@@ -0,0 +1,91 @@
+# Vates Project
+
+Open-source Python framework and sample implementations for actuarial modeling.
+
+### How this repo is organized
+
+1. **`vates/`** — The **standard** library / installable package: reusable framework code (`pip install -e .`).
+2. **`examples/model/`** — **Example / tutorial for model developers** (company builders): reference models (`fund_model.py`, `port_monte_carlo.py`) and local package(s) (`local_package/`).
+3. **Other folders under `examples/`** (`scripts/`, `cli/`, `input/`, …) — **Example / tutorial for most colleagues**: how to run models for analysis and reporting (commands, sample data), without editing framework or model code.
+4. The **`gui/`** app is another way for analysts to run tasks.
+
+## Install the framework (`vates`)
+
+Work from the **repository root**.
+
+### 1. Create a virtual environment (recommended)
+
+**PowerShell** (Windows):
+
+```powershell
+cd path\to\your\project
+python -m venv .venv
+.venv\Scripts\Activate.ps1
+```
+
+If activation is blocked by execution policy, run once in that window:
+
+```powershell
+Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
+```
+
+Then run `Activate.ps1` again.
+
+**Command Prompt** (`cmd.exe`):
+
+```bat
+cd path\to\your\project
+python -m venv .venv
+.venv\Scripts\activate.bat
+```
+
+You should see `(.venv)` in the prompt when the environment is active.
+
+### 2. Install `vates` in editable mode
+
+```powershell
+pip install -e .
+```
+
+This installs the distribution **`vates`** in editable mode; import the library as **`import vates`**.
+
+## Project layout
+
+| Path                | Role                                             |
+|---------------------|--------------------------------------------------|
+| `vates/`            | Core framework and library (`pip install -e .`). |
+| `examples/model/`   | Reference models and company-style package(s).   |
+| `examples/scripts/` | Python scripts that call the reference models.   |
+| `examples/cli/`     | CLI commands and model args json files.          |
+| `examples/input/`   | Sample CSV input data.                           |
+| `gui/`              | End-user launcher.                               |
+| `docs/`             | Structure notes and discussions.                 |
+
+
+## Quick start
+
+### 1) Example Models
+
+| No | Example Model         | Python Script                            | CLI + json                  |
+|----|-----------------------|------------------------------------------|-----------------------------|
+| 1  | 01_asset_proj         | `python .\examples\scripts\script_01.py` | `.\examples\cli\cli_01.bat` |
+| 2  | 02_fund_proj          | `python .\examples\scripts\script_02.py` | `.\examples\cli\cli_02.bat` |
+| 3  | 03_cross_proj         | `python .\examples\scripts\script_11.py` | `.\examples\cli\cli_11.bat` |
+| 5  | 21_smith_wilson       | `python .\examples\scripts\script_21.py` | `.\examples\cli\cli_21.bat` |
+
+
+- Model output can be found in `.\examples\results\script_*` and/or `.\examples\results\cli_*`
+- CLI is configured via the corresponding json file `.\examples\cli\model_args_*.json`.
+
+
+### 2) GUI
+
+Start GUI:
+```powershell
+.\gui\start.bat
+```
+
+## For model developers
+
+- Treat **`examples/model/`** as a **reference** layout: copy `local_package/` (rename to your company package) and the model files into your own repository.
+- Keep company-specific code **outside** `vates/`; depend on **`vates`** via `pip install` or your dependency mechanism.

vates-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vates"
+version = "0.1.0"
+description = "Python actuarial model"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [
+    {name = "Shanya Shi", email = "shanyashi2025@gmail.com"}
+]
+keywords = ["actuarial model", "asset-liability model", "alm"]
+dependencies = [
+    "numpy>=2.2.6",
+    "pandas>=2.3.0, <3.0.0",
+    "scipy",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["vates*"]

vates-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vates-0.1.0/vates/__init__.py

@@ -0,0 +1,30 @@
+from vates._core import (
+    cli_main,
+    cli_run,
+    ProjModelEngine,
+    StochExecutor,
+    ConstVariable,
+    TDepVariable,
+    KeyedArray,
+)
+from vates import utils
+
+from vates import alm
+from vates import solvency
+
+__all__ = [
+    # core
+    'cli_main',
+    'cli_run',
+    'ProjModelEngine',
+    'StochExecutor',
+    'ConstVariable',
+    'TDepVariable',
+    'KeyedArray',
+    # utils
+    'utils',
+    # libs
+    'alm',
+    'solvency',
+
+]

vates-0.1.0/vates/_core/__init__.py

@@ -0,0 +1,16 @@
+from vates._core.proj_model_engine import ProjModelEngine
+from vates._core.stoch_executor import StochExecutor
+from vates._core.proj_variables import ConstVariable, TDepVariable
+from vates._core.cli import cli_main, cli_run
+from vates._core.keyed_array import KeyedArray
+
+
+__all__ = [
+    'cli_main',
+    'cli_run',
+    'ProjModelEngine',
+    'StochExecutor',
+    'ConstVariable',
+    'TDepVariable',
+    'KeyedArray',
+]