Metadata-Version: 2.4
Name: episim
Version: 0.8.0a1
Summary: Epidemiology Platform for In Silico Methods
Project-URL: Homepage, https://github.com/hssling/episim
Project-URL: Documentation, https://hssling.github.io/episim
Project-URL: Issues, https://github.com/hssling/episim/issues
Author-email: "Siddalingaiah H. S." <hssling@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.11
Requires-Dist: formulaic>=1.0
Requires-Dist: matplotlib>=3.8
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.1
Requires-Dist: scikit-learn>=1.3
Requires-Dist: scipy>=1.11
Provides-Extra: app
Requires-Dist: gradio>=5.0; extra == 'app'
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == 'dev'
Requires-Dist: hypothesis>=6.100; extra == 'dev'
Requires-Dist: jupyter>=1.0; extra == 'dev'
Requires-Dist: jupytext>=1.16; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: nbmake>=1.5; extra == 'dev'
Requires-Dist: pytest-cov>=4.1; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
Description-Content-Type: text/markdown

# EPISIM - Epidemiology Platform for In Silico Methods

[![CI](https://github.com/hssling/episim/actions/workflows/ci.yml/badge.svg)](https://github.com/hssling/episim/actions/workflows/ci.yml)
[![Docs](https://github.com/hssling/episim/actions/workflows/docs.yml/badge.svg)](https://hssling.github.io/episim)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

Open-source, reproducible simulation lab for epidemiological, clinical, public-health,
and allied-science study designs.

```bash
pip install episim
```

```python
from episim.lab import run_design

study = run_design("cohort", seed_value=20260507, n=4_000)
study.archive("results/cohort_demo")
```

## Status

Alpha lab build with deterministic study archives and the full Phase-1 design registry.
Implemented surfaces currently include:

- `cross_sectional`
- `case_control`
- `cohort`
- `rct_parallel`
- `rct_cluster`
- `stepped_wedge`
- `interrupted_time_series`
- `regression_discontinuity`
- `instrumental_variables`
- `propensity_score`
- `survival_cox`
- `meta_analysis`
- `agent_based_seir`
- `microsimulation_lifetable`
- `markov_decision`
- `network_contagion`
- `qualitative_mixed_methods`
- `ecological_peai`

## Product surface

- Package API for deterministic simulation and artifact archiving
- Lab registry via `episim.lab`
- 18 notebooks for the full Phase-1 design catalog
- Hugging Face Space app in `apps/hf_space/`
- Kaggle publishing metadata in `platforms/kaggle/`
- Dockerfile, Zenodo metadata, and JOSS paper skeleton

## Roadmap

| Phase | Timing | Contents |
|---|---|---|
| **1** | Weeks 1-8 | Full 18-design teaching and methods lab |
| **2** | Weeks 9-14 | Pre-registration / methods-research lab with power, bias, design-comparison, and fairness audit packages |
| **3** | Months 4-6 | Generative AI simulation engine: natural-language to EPISIM `Study` to manuscript draft |
| **4** | Months 7-9 | Beyond medicine: educational, economic, psychological, sociological, and qualitative designs |

## Licence

MIT (code), CC-BY 4.0 (reporting checklists and figure templates).

## Citation

```text
Siddalingaiah H. S. EPISIM: Epidemiology Platform for In Silico Methods.
Alpha lab build (2026). https://github.com/hssling/episim
```
