Skip to content

Commit

Permalink
Update install docs (#202)
Browse files Browse the repository at this point in the history
* Update README.md

* Update tutorial01_installing_lava.ipynb
  • Loading branch information
mgkwill committed Mar 3, 2022
1 parent 27898a7 commit 1d1ba2c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 18 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,22 +81,22 @@ $ cd lava
$ pip install -r build-requirements.txt
$ pip install -r requirements.txt
$ pip install -e .
$ pyb -E unit
$ python -m unittest
```
Note that you should install the core Lava repository (lava) before installing other Lava libraries such as lava-optimization or lava-dl.

#### [Windows]
```cmd
cd %HOMEPATH%
python -m venv python3_venv
source python3_venv\Scripts\activate.bat
python3_venv\Scripts\activate.bat
python -m pip install --upgrade pip
git clone [email protected]:lava-nc/lava.git
cd lava
pip install -r build-requirements.txt
pip install -r requirements.txt
pip install -e .
pyb -E unit
python -m unittest
```
Note that you should install the core Lava repository (lava) before installing other Lava libraries such as lava-optimization or lava-dl.

Expand Down Expand Up @@ -127,7 +127,7 @@ Open a python terminal and run:
```bash
$ python3 -m venv python3_venv
$ pip install -U pip
$ pip install lava-nc-0.1.0.tar.gz
$ pip install lava-nc-0.3.0.tar.gz
```

### Linting, Testing, Documentation and Packaging
Expand All @@ -140,7 +140,9 @@ $ pip install -r build-requirements.txt
$ pyb analyze

# Run unit tests
$ pyb -E unit
$ pyb -E unit
# Alternate unit test run
$ python -m unittest

# Generate documentation
$ pyb sphinx_generate_documentation
Expand Down
31 changes: 18 additions & 13 deletions tutorials/in_depth/tutorial01_installing_lava.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,24 @@
"- cd lava\n",
"- pip install -r build-requirements.txt\n",
"- pip install -r requirements.txt\n",
"- export PYTHONPATH=$(pwd)/src\n",
"- pyb -E unit\n",
"- pip install -e .\n",
"- python -m unittest\n",
"\n",
"Note that you should install the core Lava repository (lava) before installing other Lava libraries such as lava-optimization or lava-dl. Test your PYTHONPATH using `echo $PYTHONPATH` and ensure 'lava/src' is the first entry that precedes any additional Lava library src paths.\n",
"Note that you should install the core Lava repository (lava) before installing other Lava libraries such as lava-optimization or lava-dl.\n",
"\n",
"#### 2.1.2 [Windows]\n",
"- cd %HOMEPATH%\n",
"- python3 -m venv python3_venv\n",
"- source python3_venv\\bin\\activate.bat\n",
"- python3_venv\\Scripts\\activate.bat\n",
"- pip install -U pip\n",
"- git clone [email protected]:lava-nc/lava.git\n",
"- cd lava\n",
"- pip install -r build-requirements.txt\n",
"- pip install -r requirements.txt\n",
"- set PYTHONPATH=%cd%\\src\n",
"- pyb -E unit\n",
"- pip install -e .\n",
"- python -m unittest\n",
"\n",
"Note that you should install the core Lava repository (lava) before installing other Lava libraries such as lava-optimization or lava-dl. Test your PYTHONPATH using `echo %PYTHONPATH%` and ensure 'lava\\src' is the first entry that precedes any additional Lava library src paths.\n",
"Note that you should install the core Lava repository (lava) before installing other Lava libraries such as lava-optimization or lava-dl.\n",
"\n",
"You should expect the following output after running the unit tests:\n",
"```\n",
Expand All @@ -89,10 +89,17 @@
"\n",
"Open a python terminal and run:\n",
"\n",
"#### [Windows/MacOS/Linux]\n",
"#### [Windows]\n",
"- python3 -m venv python3_venv\n",
"- python3_venv\\Scripts\\activate.bat\n",
"- pip install -U pip\n",
"- pip install lava-nc-0.1.0.tar.gz\n"
"- pip install lava-nc-0.3.0.tar.gz\n",
"\n",
"#### [MacOS/Linux]\n",
"- python3 -m venv python3_venv\n",
"- source python3_venv/bin/activate\n",
"- pip install -U pip\n",
"- pip install lava-nc-0.3.0.tar.gz\n"
]
},
{
Expand Down Expand Up @@ -129,8 +136,8 @@
"\n",
"- Login to INRC VM with your credentials\n",
"- Follow the instructions to Install or Clone Lava\n",
"- cd /nfs/ncl/releases/lava/0.1.0\n",
"- pip install lava-nc-0.1.0.tar.gz"
"- cd /nfs/ncl/releases/lava/0.3.0\n",
"- pip install lava-nc-0.3.0.tar.gz"
]
},
{
Expand Down Expand Up @@ -165,8 +172,6 @@
"\n",
"Lava helps you to get started by providing a range of [Tutorials](https://github.com/lava-nc/lava/tree/main/tutorials/ \"Lava Tutorials\"). \n",
"\n",
"To find and run the tutorials on your machine after cloning the source, please ensure you have set the PYTHONPATH and follow the steps below.\n",
"\n",
"#### 6.1 [Linux/MacOS]\n",
"- export PYTHONPATH=~/lava\n",
"- pip install jupyter\n",
Expand Down

0 comments on commit 1d1ba2c

Please sign in to comment.