jeffemmett
/
cadCAD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improved readme

This commit is contained in:
Joshua E. Jodesty 2019-07-30 12:53:25 -04:00
parent 176593ae0f
commit 9399c6b728
2 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -27,12 +27,13 @@ It allows us to use code to solidify our conceptualized ideas and see if the out
iteratively refine our work until we have constructed a model that closely reflects reality at the start of the model, iteratively refine our work until we have constructed a model that closely reflects reality at the start of the model,
and see how it evolves. We can then use these results to inform business decisions. and see how it evolves. We can then use these results to inform business decisions.
#### Simulation Instructional: #### Documentation:
* ##### [System Model Configuration](link) * ##### [System Model Configuration](link)
* ##### [System Simulation Execution](link) * ##### [System Simulation Execution](link)
* ##### [Tutorials](link)
#### Installation:
**1. Install Dependencies:** #### 0. Installation: Install Dependencies
**Option A:** Package Repository Access **Option A:** Package Repository Access
@ -49,22 +50,17 @@ python3 setup.py sdist bdist_wheel
pip3 install dist/*.whl pip3 install dist/*.whl
``` ```
**2. Configure Simulation:**
Intructions: #### 1. [Configure System Model](link)
`/Simulation.md`
Examples: #### 2. [Execute Simulations:](link)
`/simulations/validation/*`
**3. Import cadCAD & Run Simulations:**
##### Single Process Execution: ##### Single Process Execution:
Example [System Model Configurations](link): Example [System Model Configurations](link):
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](link): `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](link): `/documentation/examples/sys_model_B.py`
Execution Examples: Example Simulation Executions:
* [System Model A](link): `/documentation/examples/sys_model_A_exec.py` * [System Model A](link): `/documentation/examples/sys_model_A_exec.py`
* [System Model B](link): `/documentation/examples/sys_model_B_exec.py` * [System Model B](link): `/documentation/examples/sys_model_B_exec.py`
```python ```python
@ -98,7 +94,7 @@ Documentation: [Simulation Execution](link)
Example [System Model Configurations](link): Example [System Model Configurations](link):
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](link): `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](link): `/documentation/examples/sys_model_B.py`
[Execution Example:](link) `/documentation/examples/sys_model_AB_exec.py` [Example Simulation Executions::](link) `/documentation/examples/sys_model_AB_exec.py`
```python ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate

4
documentation/Execution.md
View File

@ -71,7 +71,7 @@ simulation_result = pd.DataFrame(raw_system_events)
Example [System Model Configurations](link): Example [System Model Configurations](link):
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](link): `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](link): `/documentation/examples/sys_model_B.py`
Execution Examples: Example Simulation Executions:
* [System Model A](link): `/documentation/examples/sys_model_A_exec.py` * [System Model A](link): `/documentation/examples/sys_model_A_exec.py`
* [System Model B](link): `/documentation/examples/sys_model_B_exec.py` * [System Model B](link): `/documentation/examples/sys_model_B_exec.py`
```python ```python
@ -103,7 +103,7 @@ print()
* ##### *Multi Process Execution* * ##### *Multi Process Execution*
Documentation: [Simulation Execution](link) Documentation: [Simulation Execution](link)
[Execution Example:](link) `/documentation/examples/sys_model_AB_exec.py` [Example Simulation Executions::](link) `/documentation/examples/sys_model_AB_exec.py`
Example [System Model Configurations](link): Example [System Model Configurations](link):
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](link): `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](link): `/documentation/examples/sys_model_B.py`