From f0ada7b82017552fdbe25ce1839a0cbc0ad13d56 Mon Sep 17 00:00:00 2001 From: Markus Buhatem Koch <34865315+markusbkoch@users.noreply.github.com> Date: Tue, 13 Nov 2018 18:16:15 -0200 Subject: [PATCH] Update README.md --- README.md | 30 ++++++------------------------ 1 file changed, 6 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f09c380..0bcd777 100644 --- a/README.md +++ b/README.md @@ -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**