71 lines
1.5 KiB
Markdown
71 lines
1.5 KiB
Markdown
# SimCad
|
|
|
|
**Dependencies:**
|
|
```bash
|
|
pip install pathos pipenv fn tabulate
|
|
```
|
|
|
|
**Project:**
|
|
|
|
Example Runs:
|
|
`/DiffyQ-SimCAD/sandboxUX/sim_test.py`
|
|
|
|
Example Configurations:
|
|
`/DiffyQ-SimCAD/sandboxUX/connfig#.py`
|
|
|
|
**User Interface: Simulation Configuration**
|
|
|
|
Configurations:
|
|
```bash
|
|
/DiffyQ-SimCAD/ui/config.py
|
|
```
|
|
|
|
**Build Tool & Package Import:**
|
|
|
|
Step 1. Build & Install Package locally:
|
|
```bash
|
|
pip install .
|
|
pip install -e .
|
|
```
|
|
* [Package Creation Tutorial](https://python-packaging.readthedocs.io/en/latest/minimal.html)
|
|
|
|
Step 2. Import Package & Run:
|
|
```python
|
|
import pandas as pd
|
|
from tabulate import tabulate
|
|
|
|
from SimCAD.engine import ExecutionContext, Executor
|
|
from sandboxUX import config1, config2
|
|
|
|
print("Simulation Run 1")
|
|
print()
|
|
single_config = [config1]
|
|
run1 = Executor(ExecutionContext, single_config)
|
|
run1_raw_result = run1.main()
|
|
result = pd.DataFrame(run1_raw_result)
|
|
print(tabulate(result, headers='keys', tablefmt='psql'))
|
|
print()
|
|
|
|
print("Simulation Run 2: Pairwise Execution")
|
|
print()
|
|
configs = [config1, config2]
|
|
run2 = Executor(ExecutionContext, configs)
|
|
run2_raw_results = run2.main()
|
|
for raw_result in run2_raw_results:
|
|
result = pd.DataFrame(raw_result)
|
|
print(tabulate(result, headers='keys', tablefmt='psql'))
|
|
print()
|
|
```
|
|
|
|
Same can be run in Jupyter .
|
|
```bash
|
|
jupyter notebook
|
|
```
|
|
|
|
Notebooks Directory:
|
|
`/DiffyQ-SimCAD/notebooks/`
|
|
|
|
|
|
**Warning**:
|
|
**Do Not** publish this package / software to **Any** software repository **except** [DiffyQ-SimCAD's staging branch](https://github.com/BlockScience/DiffyQ-SimCAD/tree/staging) or its **Fork**
|