Merge pull request #42 from RyanAugust/dev

Examples

Author: RyanAugust

example_config.yaml examples/example_config.yamlexample_config.yaml renamed to examples/example_config.yaml

@@ -0,0 +1,169 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0",
+   "metadata": {},
+   "source": [
+    "## Simple Simulation\n",
+    "___\n",
+    "The most basic function of the package. Generate 5 years worth of investment data against 4 channels (using example configuration)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pysimmmulator import Simulate, load_config"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "cfg = load_config(config_path=\"../example_config.yaml\")\n",
+    "simmm = Simulate()\n",
+    "mmm_input_df, channel_roi = simmm.run_with_config(config=cfg)\n",
+    "mmm_input_df.head()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3",
+   "metadata": {},
+   "source": [
+    "## Distribution to Geos\n",
+    "___\n",
+    "Take the MMM data that was generated in the simulation and project that into geographies"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pysimmmulator import Geos, distribute_to_geos"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "united_states = Geos(total_population=330_000_000)\n",
+    "states = united_states.create_random_geos(count=50)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "dis_mmm_input_df = distribute_to_geos(mmm_input=mmm_input_df, geo_details=states)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "dis_mmm_input_df.head(10)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8",
+   "metadata": {},
+   "source": [
+    "## Generate Studies\n",
+    "___\n",
+    "Using the true roi's of each channel, generate x simulated studies per channel"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pysimmmulator import Study, BatchStudy\n",
+    "import matplotlib.pyplot as plt"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "10",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "ct = 8\n",
+    "studies = BatchStudy(channel_rois=channel_roi)\n",
+    "sim_studies = studies.generate(ct)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "11",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig, ax = plt.subplots(2,2, figsize=(6,6), dpi=100)\n",
+    "chans = list(sim_studies.keys())\n",
+    "for a in range(2): \n",
+    "  for b in range(2):\n",
+    "    f = ax[a][b]\n",
+    "    chan = chans.pop()\n",
+    "    f.hist(sim_studies[chan], bins=ct*2, color='red', alpha=.75)\n",
+    "    f.axvline(channel_roi[chan], ls='--', color='black')\n",
+    "    f.set_title(f\"{chan} results (n={ct})\")\n",
+    "plt.tight_layout()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "12",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.13.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

example_config_dict.py examples/example_config_dict.pyexample_config_dict.py renamed to examples/example_config_dict.py

@@ -1 +1 @@
-0.5.0
+0.5.1

examples/simulation.ipynb

@@ -3,7 +3,7 @@
 __author__ = "RyanAugust"
 __license__ = "MIT"
 __copyright__ = "Copyright 2025"
-__version__ = "0.5.0"
+__version__ = "0.5.1"
 
 from .simulate import Simulate, Multisim
 from .load_parameters import load_config, define_basic_params