Migrated from GitHub
Go to file
Joshua E. Jodesty 185bef3910 dante's inferno 2018-10-10 21:02:59 -04:00
engine packaging pt 2 2018-10-10 19:54:31 -04:00
notebooks dante's inferno 2018-10-10 21:02:59 -04:00
ui packaging pt 2 2018-10-10 19:54:31 -04:00
.gitignore ignore .ds_store 2018-09-11 09:44:50 -03:00
Pipfile install common packages 2018-09-17 13:38:22 -03:00
Pipfile.lock install common packages 2018-09-17 13:38:22 -03:00
README.md updated readme pt. 2 VC Hell 2018-10-10 20:54:04 -04:00
setup.py init packaging 2018-10-09 15:13:38 -04:00
test.py packaging pt 2 2018-10-10 19:54:31 -04:00

README.md

SimCad

Dependencies:

Install pipenv

Project:

Example Run File: /DiffyQ-SimCAD/test.py

User Interface: Simulation Configuration

Configurations:

/DiffyQ-SimCAD/ui/config.py

Build Tool & Package Import:

Build & Install Package locally:

pip install .

Import Package & Run:

from engine import run
run.main()

Warning: Do Not publish this package / software to Any software repository except DiffyQ-SimCAD's staging branch or its Fork

Jupyter Setup:

Step 1. Create Virtual Environment:

cd DiffyQ-SimCAD
pipenv run python -m ipykernel install --user --name DiffyQ-SimCAD --display-name "DiffyQ-SimCAD Env"

Step 2. Run Jupter Notebook:

pipenv run jupyter notebook

Step 3. Notebook Management:

Notebook Directory:

/DiffyQ-SimCAD/notebooks/

Note:

Notebooks should run on the DiffyQ-SimCAD Env kernel.