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

new readme

This commit is contained in:
Joshua E. Jodesty 2019-01-07 18:48:07 -05:00
parent 81a200fe9c ab3a9e370d
commit 80ec1a36b9
1 changed files with 14 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -1,42 +1,30 @@
# SimCad # SimCad
**Warning**:
**Do not** publish this package / software to **any** software repository **except** one permited by BlockScience.
**Dependencies:** **1. Install Dependencies:**
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
pip install .
``` ```
**Project:** **2. Configure Simulation:**
Example Runs: Example:
`/simulations/validation/*`
**3. Import SimCAD & Run Simulation:**
Example:
`/simulations/sim_test.py` `/simulations/sim_test.py`
Example Configurations:
`/simulations/validation/`
**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 ```python
import pandas as pd import pandas as pd
from tabulate import tabulate from tabulate import tabulate
# The following imports NEED to be in the exact same order # The following imports NEED to be in the exact same order
from SimCAD.engine import ExecutionMode, ExecutionContext, Executor from SimCAD.engine import ExecutionMode, ExecutionContext, Executor
from simulations.validation import config1, config2 from simulations.validation import config_1, config_2
from SimCAD import configs from SimCAD import configs
# ToDo: pass ExecutionContext with execution method as ExecutionContext input # ToDo: pass ExecutionContext with execution method as ExecutionContext input
@ -44,9 +32,6 @@ from SimCAD import configs
exec_mode = ExecutionMode() exec_mode = ExecutionMode()
exec_mode = ExecutionMode()
print("Simulation Execution 1") print("Simulation Execution 1")
print() print()
first_config = [configs[0]] # from config1 first_config = [configs[0]] # from config1
@ -76,14 +61,7 @@ for raw_result, tensor_field in run2.main():
print() print()
``` ```
Same can be run in Jupyter . The above can be run in Jupyter.
```bash ```bash
jupyter notebook 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**