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

fixing likns

This commit is contained in:
Joshua E. Jodesty 2019-08-22 14:26:03 -04:00
parent 7d0a14efbf
commit 2a37eb5c02
6 changed files with 60 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -39,14 +39,21 @@ iteratively refine our work until we have constructed a model that closely refle
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.
#### Documentation: #### Documentation:
* ##### [System Model Configuration](link) * ##### [Tutorials](tutorials)
* ##### [System Simulation Execution](link) * ##### [System Model Configuration](documentation/Simulation_Configuration.md)
* ##### [Tutorials](link) * ##### [System Simulation Execution](documentation/Simulation_Execution.md)
#### 0. Installation: #### 0. Installation:
**Option A:** Proprietary Build Access **Option A:** Build From Source
```bash
pip3 install -r requirements.txt
python3 setup.py sdist bdist_wheel
pip3 install dist/*.whl
```
**Option B:** Proprietary Build Access
***IMPORTANT NOTE:*** Tokens are issued to those with access to proprietary builds of cadCAD and BlockScience employees **ONLY**. ***IMPORTANT NOTE:*** Tokens are issued to those with access to proprietary builds of cadCAD and BlockScience employees **ONLY**.
Replace \<TOKEN\> with an issued token in the script below. Replace \<TOKEN\> with an issued token in the script below.
@ -55,25 +62,24 @@ pip3 install pandas pathos fn funcy tabulate
pip3 install cadCAD --extra-index-url https://<TOKEN>@repo.fury.io/blockscience/ pip3 install cadCAD --extra-index-url https://<TOKEN>@repo.fury.io/blockscience/
``` ```
**Option B:** Build From Source
```bash
pip3 install -r requirements.txt
python3 setup.py sdist bdist_wheel
pip3 install dist/*.whl
```
#### 1. [Configure System Model](documentation/Simulation_Configuration.md)
#### 1. [Configure System Model](link) #### 2. [Execute Simulations:](documentation/Simulation_Execution.md)
#### 2. [Execute Simulations:](link)
##### Single Process Execution: ##### Single Process Execution:
Example [System Model Configurations](link): Example System Model Configurations:
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](documentation/examples/sys_model_A.py):
* [System Model B](link): `/documentation/examples/sys_model_B.py` `/documentation/examples/sys_model_A.py`
* [System Model B](documentation/examples/sys_model_B.py):
`/documentation/examples/sys_model_B.py`
Example Simulation Executions: Example Simulation Executions:
* [System Model A](link): `/documentation/examples/sys_model_A_exec.py` * [System Model A](documentation/examples/sys_model_A_exec.py):
* [System Model B](link): `/documentation/examples/sys_model_B_exec.py` `/documentation/examples/sys_model_A_exec.py`
* [System Model B](documentation/examples/sys_model_B_exec.py):
`/documentation/examples/sys_model_B_exec.py`
```python ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate
@ -99,13 +105,17 @@ print(tabulate(sys_model_A_result, headers='keys', tablefmt='psql'))
print() print()
``` ```
### Multiple Simulations (Concurrent): ##### Multiple Simulations (Concurrent):
##### Multiple Simulation Execution (Multi Process Execution) ###### Multiple Simulation Execution (Multi Process Execution)
Documentation: [Simulation Execution](link) System Model Configurations:
Example [System Model Configurations](link): * [System Model A](documentation/examples/sys_model_A.py):
* [System Model A](link): `/documentation/examples/sys_model_A.py` `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](documentation/examples/sys_model_B.py):
[Example Simulation Executions::](link) `/documentation/examples/sys_model_AB_exec.py` `/documentation/examples/sys_model_B.py`
[Example Simulation Executions:](documentation/examples/sys_model_AB_exec.py)
`/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
@ -133,9 +143,10 @@ for sys_model_AB_raw_result, sys_model_AB_tensor_field in sys_model_AB_simulatio
i += 1 i += 1
``` ```
### Parameter Sweep Simulation (Concurrent): ##### Parameter Sweep Simulation (Concurrent):
Documentation: [System Model Parameter Sweep](link) [Example:](documentation/examples/param_sweep.py)
[Example:](link) `/documentation/examples/param_sweep.py` `/documentation/examples/param_sweep.py`
```python ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate
@ -157,11 +168,3 @@ for raw_result, tensor_field in run.execute():
print(tabulate(result, headers='keys', tablefmt='psql')) print(tabulate(result, headers='keys', tablefmt='psql'))
print() print()
``` ```
### Tests:
```python
python -m unittest testing/tests/param_sweep.py
python -m unittest testing/tests/policy_aggregation.py
python -m unittest testing/tests/historical_state_access.py
python -m unittest testing/tests/external_dataset.py
```

6
documentation/Historically_State_Access.md
View File

@ -50,10 +50,10 @@ def nonexistent(_params, substep, sH, s, _input):
return 'nonexistent', access_block(sH, "nonexistent", 0, exclusion_list) return 'nonexistent', access_block(sH, "nonexistent", 0, exclusion_list)
``` ```
#### Example Simulation #### [Example Simulation:](examples/historical_state_access.py)
link
#### Example Output
#### Example Output:
###### State History ###### State History
``` ```
+----+-------+-----------+------------+-----+ +----+-------+-----------+------------+-----+

2
documentation/Policy_Aggregation.md
View File

@ -57,7 +57,7 @@ append_configs(
``` ```
#### Example #### Example
##### * [System Model Configuration](https://github.com/BlockScience/cadCAD-Tutorials/blob/master/Documentation/examples/policy_aggregation.py) ##### * [System Model Configuration](examples/policy_aggregation.py)
##### * Simulation Results: ##### * Simulation Results:
``` ```
+----+---------------------------------------------+-------+------+-----------+------------+ +----+---------------------------------------------+-------+------+-----------+------------+

7
documentation/Simulation_Configuration.md
View File

@ -70,7 +70,7 @@ in the simulation. In other words, for how long do they want to simulate the sys
cadCAD facilitates running multiple simulations of the same system sequentially, reporting the results of all those cadCAD facilitates running multiple simulations of the same system sequentially, reporting the results of all those
runs in a single dataset. This is especially helpful for running runs in a single dataset. This is especially helpful for running
[Monte Carlo Simulations](https://github.com/BlockScience/cadCAD-Tutorials/blob/master/01%20Tutorials/robot-marbles-part-4/robot-marbles-part-4.ipynb). [Monte Carlo Simulations](../tutorials/robot-marbles-part-4/robot-marbles-part-4.ipynb).
### M - Parameters of the System ### M - Parameters of the System
@ -137,7 +137,7 @@ cadCAD relies on in order to run the simulation according to the specifications.
### Policy Functions ### Policy Functions
A Policy Function computes one or more signals to be passed to [State Update Functions](#State-Update-Functions) A Policy Function computes one or more signals to be passed to [State Update Functions](#State-Update-Functions)
(via the _\_input_ parameter). Read (via the _\_input_ parameter). Read
[this article](https://github.com/BlockScience/cadCAD-Tutorials/blob/master/01%20Tutorials/robot-marbles-part-2/robot-marbles-part-2.ipynb) [this article](../tutorials/robot-marbles-part-2/robot-marbles-part-2.ipynb)
for details on why and when to use policy functions. for details on why and when to use policy functions.
<!-- We would then expand the tutorials with these kind of concepts <!-- We would then expand the tutorials with these kind of concepts
@ -218,6 +218,7 @@ append_configs(
partial_state_update_blocks = PSUBs, partial_state_update_blocks = PSUBs,
... ...
) )
``` ```
#### Substep #### Substep
@ -237,4 +238,4 @@ Update Blocks)
Therefore, the total number of records in the resulting dataset is `N` x `T` x `len(partial_state_update_blocks)` Therefore, the total number of records in the resulting dataset is `N` x `T` x `len(partial_state_update_blocks)`
#### [System Simulation Execution](https://github.com/BlockScience/cadCAD-Tutorials/blob/master/documentation/Simulation_Execution.md) #### [System Simulation Execution](Simulation_Execution.md)

24
documentation/Simulation_Execution.md
View File

@ -68,12 +68,12 @@ simulation_result = pd.DataFrame(raw_system_events)
### Execution Examples: ### Execution Examples:
##### Single Simulation Execution (Single Process Execution) ##### Single Simulation Execution (Single Process Execution)
Example [System Model Configurations](link): Example System Model Configurations:
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](examples/sys_model_A.py): `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](examples/sys_model_B.py): `/documentation/examples/sys_model_B.py`
Example Simulation Executions: Example Simulation Executions:
* [System Model A](link): `/documentation/examples/sys_model_A_exec.py` * [System Model A](examples/sys_model_A_exec.py): `/documentation/examples/sys_model_A_exec.py`
* [System Model B](link): `/documentation/examples/sys_model_B_exec.py` * [System Model B](examples/sys_model_B_exec.py): `/documentation/examples/sys_model_B_exec.py`
```python ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate
@ -102,11 +102,11 @@ print()
##### Multiple Simulation Execution ##### Multiple Simulation Execution
* ##### *Multi Process Execution* * ##### *Multi Process Execution*
Documentation: [Simulation Execution](link) Documentation: Simulation Execution
[Example Simulation Executions::](link) `/documentation/examples/sys_model_AB_exec.py` [Example Simulation Executions::](examples/sys_model_AB_exec.py) `/documentation/examples/sys_model_AB_exec.py`
Example [System Model Configurations](link): Example System Model Configurations:
* [System Model A](link): `/documentation/examples/sys_model_A.py` * [System Model A](examples/sys_model_A.py): `/documentation/examples/sys_model_A.py`
* [System Model B](link): `/documentation/examples/sys_model_B.py` * [System Model B](examples/sys_model_B.py): `/documentation/examples/sys_model_B.py`
```python ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate
@ -135,8 +135,8 @@ for sys_model_AB_raw_result, sys_model_AB_tensor_field in sys_model_AB_simulatio
``` ```
* ##### *Parameter Sweep* * ##### *Parameter Sweep*
Documentation: [System Model Parameter Sweep](link) Documentation: [System Model Parameter Sweep](System_Model_Parameter_Sweep.md)
[Example:](link) `/documentation/examples/param_sweep.py` [Example:](examples/param_sweep.py) `/documentation/examples/param_sweep.py`
```python ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate

3
documentation/System_Model_Parameter_Sweep.md
View File

@ -69,5 +69,4 @@ sim_config = config_sim(
) )
``` ```
#### Example #### Example
##### * [System Model Configuration](https://github.com/BlockScience/cadCAD-Tutorials/blob/master/Documentation/examples/param_sweep.py) ##### * [System Model Configuration](examples/param_sweep.py)
##### * Simulation Results: