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

merge new readme

This commit is contained in:
Joshua E. Jodesty 2018-11-13 15:28:01 -05:00
parent f30778873e f0ada7b820
commit b5ef8b991c
1 changed files with 6 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -26,38 +26,20 @@ pip install -e .
```
* [Package Creation Tutorial](https://python-packaging.readthedocs.io/en/latest/minimal.html)
Step 2. Import Package & Run:
Step 2. 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:
Same can be run in Jupyter .
```bash
cd DiffyQ-SimCAD
pipenv run python -m ipykernel install --user --name DiffyQ-SimCAD --display-name "DiffyQ-SimCAD Env"
jupyter notebook
```
Step 2. Run Jupter Notebook:
```bash
pipenv run jupyter notebook
```
Step 3. Notebook Management:
Notebook Directory:
Notebooks Directory:
`/DiffyQ-SimCAD/notebooks/`
Note:
Notebooks should run on the `DiffyQ-SimCAD Env` kernel.
**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**