51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
```
|
|
__________ ____
|
|
________ __ _____/ ____/ | / __ \
|
|
/ ___/ __` / __ / / / /| | / / / /
|
|
/ /__/ /_/ / /_/ / /___/ ___ |/ /_/ /
|
|
\___/\__,_/\__,_/\____/_/ |_/_____/
|
|
by BlockScience
|
|
======================================
|
|
Complex Adaptive Dynamics
|
|
o i e
|
|
m d s
|
|
p e i
|
|
u d g
|
|
t n
|
|
e
|
|
r
|
|
```
|
|
***cadCAD*** is a Python package that assists in the processes of designing, testing and validating complex systems through simulation, with support for Monte Carlo methods, A/B testing and parameter sweeping.
|
|
|
|
# Getting Started
|
|
## 1. Installation:
|
|
Requires [Python 3](https://www.python.org/downloads/)
|
|
|
|
**Option A: Install Using [pip](https://pypi.org/project/cadCAD/)**
|
|
```bash
|
|
pip3 install cadCAD
|
|
```
|
|
|
|
**Option B:** Build From Source
|
|
```
|
|
pip3 install -r requirements.txt
|
|
python3 setup.py sdist bdist_wheel
|
|
pip3 install dist/*.whl
|
|
```
|
|
|
|
|
|
## 2. Learn the basics
|
|
**Tutorials:** available both as [Jupyter Notebooks](tutorials)
|
|
and [videos](https://www.youtube.com/watch?v=uJEiYHRWA9g&list=PLmWm8ksQq4YKtdRV-SoinhV6LbQMgX1we)
|
|
|
|
Familiarize yourself with some system modelling concepts and cadCAD terminology.
|
|
|
|
## 3. Documentation:
|
|
* [System Model Configuration](documentation/Simulation_Configuration.md)
|
|
* [System Simulation Execution](documentation/Simulation_Execution.md)
|
|
* [Policy Aggregation](documentation/Policy_Aggregation.md)
|
|
* [System Model Parameter Sweep](documentation/System_Model_Parameter_Sweep.md)
|
|
|
|
## 4. Connect
|
|
Find other cadCAD users at our [Discourse](https://community.cadcad.org/). We are a small but rapidly growing community.
|