updated README with instructions

This commit is contained in:
Joshua E. Jodesty 2018-10-10 20:34:23 -04:00
parent b767792c00
commit c1439cb7f0
1 changed files with 53 additions and 3 deletions

View File

@ -1,11 +1,61 @@
# DiffyQ-SimCAD
If you don't already have it installed, install [pipenv](https://pypi.org/project/pipenv/)
**Dependencies:**
Clone this repo, then
Install [pipenv](https://pypi.org/project/pipenv/)
**Project:**
Example Run File:
`/DiffyQ-SimCAD/test.py`
**User Interface: Simulation Configuration**
Configurations:
```bash
/DiffyQ-SimCAD/ui/config.py
```
**Build Tool & Package Import:**
Build & Install Package locally:
```bash
pip install .
```
* [Package Creation Tutorial](https://python-packaging.readthedocs.io/en/latest/minimal.html)
Import Package & Run:
```python
from engine import run
run.main()
```
**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**
**Jupyter Setup:**
Step 1. Create Virtual Environment:
```bash
cd DiffyQ-SimCAD
pipenv run python -m ipykernel install --user --name DiffyQ-SimCAD --display-name "DiffyQ-SimCAD Env"
```
Step 2. Run Jupter Notebook:
```bash
pipenv run jupyter notebook
```
When you open `TestNotebook.ipynb`, you should see it running on the `DiffyQ-SimCAD Env` Kernel
Step 3. Notebook Management:
Notebook Directory:
`/DiffyQ-SimCAD/notebooks/`
Note:
Notebooks should run on the `DiffyQ-SimCAD Env` kernel.