Skip to content

Commit

Permalink
Install guide updates (ronpandolfi#12)
Browse files Browse the repository at this point in the history
* Update install doc

* Fix xi-cam github urls

* Fix order of xi-cam installs

* Update install doc for Windows
  • Loading branch information
ihumphrey authored and ronpandolfi committed Jul 23, 2019
1 parent 4443f4d commit da85086
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions docs/source/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,20 @@ Create a virtual environment for installing the Xi-cam components and
dependencies. You will then want to activate the virtual environment you
created so that any packages you install with python's package manager, **pip**,
will be installed into that active virtual environment. In the commands below,
replace `<directory>` with the directory that you want to install your virtual
environment in:
create a virtual environment called **venv** and activate it:

### macOS

```
python3 -m venv venv
source venv/bin/actviate
```

### Windows

```
python3 -m venv <directory>
source <directory>/bin/actviate
python -m venv venv
venv\Scripts\activate
```

## Install Xi-cam and Core Dependencies
Expand All @@ -77,25 +85,26 @@ Xi-cam.gui, Xi-cam.plugins, and Xi-cam.
Then, install these into your active virtual environment via pip.
Use the **-e** option to create an editable installation. This allows you to
modify any code in these repos and see the changes without having to run
`pip install` again.
`pip install` again. (If on Windows, run the following commands using
**Git Bash**.)

```
git clone https://github.com/Xi-cam.core
git clone https://github.com/lbl-camera/Xi-cam.core
cd Xi-cam.core
pip install -e .
cd ..
git clone https://github.com/Xi-cam.gui
cd Xi-cam.gui
git clone https://github.com/lbl-camera/Xi-cam.plugins
cd Xi-cam.plugins
pip install -e .
cd ..
git clone https://github.com/Xi-cam.plugins
cd Xi-cam.plugins
git clone https://github.com/lbl-camera/Xi-cam.gui
cd Xi-cam.gui
pip install -e .
cd ..
git clone https://github.com/Xi-cam
git clone https://github.com/lbl-camera/Xi-cam
cd Xi-cam
pip install -e .
```
Expand All @@ -107,10 +116,17 @@ To ensure everything is installed correctly, you can run Xi-cam. In the
xicam
```

<!--
NOTES
-----
Anaconda to keep PATH active (opposed to having to activate every time)
-->

<!--
* test these instructions on windows
* test the install
* test the venv creation
* test the cloning (git bash?)
* test run_xicam
-->
-->

0 comments on commit da85086

Please sign in to comment.