Skip to content

Commit 2ecb442

Browse files
committed
update docs for windows install
1 parent 02178a4 commit 2ecb442

1 file changed

Lines changed: 31 additions & 4 deletions

File tree

docs/installing-countess/index.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ layout: default
77
CountESS uses 'biobear', which is developed in Rust, so if you can't use a precompiled wheel
88
for biobear you'll need to install rust first, eg: `apt install rust-all` on Ubuntu.
99

10-
## ... using pip
10+
## Linux
11+
12+
### ... using pip
1113

1214
CountESS can be [installed from pypi](https://pypi.org/project/countess/):
1315

@@ -17,7 +19,7 @@ CountESS can be [installed from pypi](https://pypi.org/project/countess/):
1719

1820
pip install git+https://github.com/CountESS-Project/CountESS.git
1921

20-
## ... using git, for development
22+
### ... using git, for development
2123

2224
Clone the repository and [install for development](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e):
2325

@@ -27,14 +29,14 @@ Clone the repository and [install for development](https://pip.pypa.io/en/stable
2729

2830
See [Contributing to CountESS](../contributing/) for more information on development.
2931

30-
## ... using nix
32+
### ... using nix
3133

3234
CountESS can be installed and run in one command with
3335
[nix](https://nixos.org/):
3436

3537
nix run github:CountESS-Project/CountESS
3638

37-
## ... under homebrew
39+
## MacOS, using Homebrew
3840

3941
Even recent MacOS installs use a very old version of Python and Tk, so
4042
we use [homebrew](https://brew.sh/) to install more recent versions.
@@ -76,6 +78,31 @@ we use [homebrew](https://brew.sh/) to install more recent versions.
7678
brew install hdf5
7779
pip3.10 install countess[hdf5]
7880

81+
82+
## Windows
83+
84+
* Install Python 3 from python.org
85+
86+
https://docs.python.org/3/using/windows.html
87+
88+
Under "Optional Features" select "py launcher" to make it easier to start python from the command shell.
89+
Under "Advanced Options" select "Add Python to environment variables"
90+
91+
* Install rust;
92+
93+
* download `rustup-init.exe` from [rustup.rs](https://rustup.rs/)
94+
95+
* run `rustup-init.exe` and if you haven't alrady got
96+
VS Code installed, select 1 to install it.
97+
It'll ask you to reboot. Once it's rebooted run
98+
`rustup-init.exe` again ...
99+
100+
* rust and cargo will be installed.
101+
102+
* now open `cmd.exe` and run `pip install countess`.
103+
104+
* this may take quite some time to install depending on
105+
which packages are being built from source.
79106

80107
# NEXT
81108

0 commit comments

Comments
 (0)