|
|
||
|---|---|---|
| engine | ||
| notebooks | ||
| ui | ||
| .gitignore | ||
| Pipfile | ||
| Pipfile.lock | ||
| README.md | ||
| setup.py | ||
| test.py | ||
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.