shock: defining new lab environment and formulation

lab/docs/Makefile

@@ -0,0 +1,12 @@
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

lab/docs/conf.py

@@ -0,0 +1,39 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+project = 'Quote-Control Simulator'
+copyright = '2025, PHANTOM Research'
+author = 'PHANTOM Research'
+release = '0.1.0'
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosummary',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
+
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'show-inheritance': True,
+}
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+}
+
+autosummary_generate = True

lab/docs/index.rst

@@ -0,0 +1,39 @@
+Quote-Control Simulator
+=======================
+
+Research-grade platform for dynamic pricing and market making experiments.
+
+The platform abstracts pricing as: **Quote → Arrival → Execution → Position**
+
+Supports multiple mechanisms:
+
+* **PostedPrice**: retail dynamic pricing
+* **TwoSided**: market making with bid-ask spreads
+* **Auction**: reserve/shading for auction settings
+
+Quick Start
+-----------
+
+.. code-block:: python
+
+   from lab.config import make_retail_platform
+   from lab.experiments import rollout, fixed_price_policy
+
+   platform = make_retail_platform()
+   policy = fixed_price_policy(platform.instruments.refs)
+   result = rollout(platform, policy, n_steps=100)
+   print(f"Total PnL: {result.total_pnl:.2f}")
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules/outlet
+   modules/population
+   modules/experiments
+
+Indices
+-------
+
+* :ref:`genindex`
+* :ref:`modindex`

lab/docs/modules/experiments.rst

@@ -0,0 +1,14 @@
+Experiments
+===========
+
+Evaluation & OPE
+----------------
+
+.. automodule:: lab.experiments.eval
+   :members:
+
+Configuration
+-------------
+
+.. automodule:: lab.config
+   :members:

lab/docs/modules/outlet.rst

@@ -0,0 +1,77 @@
+Outlet (Core Simulator)
+=======================
+
+Types
+-----
+
+.. automodule:: lab.outlet.types
+   :members:
+
+Constants
+---------
+
+.. automodule:: lab.outlet.constants
+   :members:
+
+Protocols
+---------
+
+.. automodule:: lab.outlet.protocols
+   :members:
+
+Platform
+--------
+
+.. automodule:: lab.outlet.platform
+   :members:
+
+Stock & Position
+----------------
+
+.. automodule:: lab.outlet.stock
+   :members:
+
+Observation
+-----------
+
+.. automodule:: lab.outlet.observation
+   :members:
+
+Mechanisms
+----------
+
+Posted Price
+~~~~~~~~~~~~
+
+.. automodule:: lab.outlet.mechanisms.posted_price
+   :members:
+
+Two-Sided (Market Making)
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: lab.outlet.mechanisms.two_sided
+   :members:
+
+Auction
+~~~~~~~
+
+.. automodule:: lab.outlet.mechanisms.auction
+   :members:
+
+Objectives
+----------
+
+.. automodule:: lab.outlet.objectives.base
+   :members:
+
+.. automodule:: lab.outlet.objectives.penalties
+   :members:
+
+.. automodule:: lab.outlet.objectives.factory
+   :members:
+
+Math Utilities
+--------------
+
+.. automodule:: lab.outlet.math_util
+   :members:

lab/docs/modules/population.rst

@@ -0,0 +1,20 @@
+Population Models
+=================
+
+Arrival Models
+--------------
+
+.. automodule:: lab.population.arrivals
+   :members:
+
+Execution Models
+----------------
+
+.. automodule:: lab.population.execution
+   :members:
+
+Competitor / Market Models
+--------------------------
+
+.. automodule:: lab.population.competitors
+   :members: