Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding windows install instructions #1227

Merged
merged 2 commits into from
Apr 22, 2019
Merged

Adding windows install instructions #1227

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32ed57b
adding windows setup
Apr 19, 2019
a37fb0a
adding missing instruction
Apr 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/source/getting_started/installation/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,39 @@ Finally, then install starfish:
.. code-block:: bash

% make install-dev

Step by Step Installation on Windows
--------------------------------------

We recommend using starfish with a Windows Linux Subsystem (WSL)

Instructions on how to download and install a new WSL can be found here: `WSL install manual`_

.. _`WSL install manual`: https://docs.microsoft.com/en-us/windows/wsl/install-manual

Once your WSL is running, run an apt-get update and install pip

.. code-block:: bash

% sudo apt-get update
% sudo apt-get install python3-pip

Clone the starfish repo

.. code-block:: bash

% git checkout [email protected]:spacetx/starfish.git
% cd starfish

Install and activate a virtualenv

.. code-block:: bash

% python3 -m pip install --user virtualenv
ttung marked this conversation as resolved.
Show resolved Hide resolved
% source venv/bin/activate

Finally, then install starfish:

.. code-block:: bash

% make install-dev