getting started - zfifteen/unified-framework GitHub Wiki
Overview
- Quick-start guide to run core examples and use the Z Framework codebase.
Prerequisites
- Python 3.9+ (or as required by repo)
- pip packages: mpmath, numpy, sympy, pandas, matplotlib
- Example:
pip install mpmath numpy sympy pandas matplotlib
- Example:
Clone repository
- GitHub Wiki is separate from main repo; the wiki URL is: https://github.com/zfifteen/unified-framework.wiki.git
Basic usage examples
- Run core examples:
- Example:
python axioms.py --example simple_z
(adjust for repository CLI)
- Example:
- Notebook:
- Open
Z5D_Reference_Impl-2.ipynb
via Jupyter or nbviewer.
- Open
Reproducibility
- Use mpmath for high-precision runs (set mp.dps to achieve precision < 1e-16 where required).
- Label any experimental hypothesis as UNVERIFIED in logs and notebook cells.
Next steps
- Visit Core Concepts for mathematical background.
- See Implementations for API details and code examples.