Skip to content

Commit 689fb68

Browse files
committed
update readme install instructions
1 parent e6e4c0c commit 689fb68

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,34 @@ PyHDX is python project which can be used to derive Gibbs free energy from HDX-M
1919

2020
## Installation
2121

22-
Installation of the latest stable beta with `pip`:
22+
Installation of PyHDX with [uv](https://docs.astral.sh/uv/getting-started/installation/):
2323

24+
Create a uv virtual environment, specifying python version 3.11:
25+
26+
```bash
27+
$ uv venv -p "3.11"
28+
```
29+
30+
Then activate environment as instructed by uv, e.g.:
31+
32+
Windows:
33+
```bash
34+
$ .venv/Script/activate
35+
```
36+
37+
Linux/Mac:
2438
```bash
25-
$ pip install pyhdx
39+
$ source .venv/bin/activate
2640
```
2741

28-
Installation with web interface extra:
42+
To install PyHDX:
43+
```bash
44+
$ uv pip install pyhdx
45+
```
2946

47+
With web interface extra:
3048
```bash
31-
$ pip install pyhdx[web]
49+
$ uv pip install pyhdx[web]
3250
```
3351

3452
Conda install (includes web interface extra):
@@ -46,9 +64,13 @@ To run the web server:
4664
```bash
4765
$ pyhdx serve
4866
```
49-
67+
68+
To add datasets to directly load into PyHDX, configure the `database_dir` parameter in the config file (default: `~/.hdxms_datasets/datasets`), and place `hdxms-datasets` v0.1.5 (legacy) compatible datasets there.
69+
5070
Please refer to the [docs](https://pyhdx.readthedocs.io/en/stable/) for more details on how to run PyHDX.
5171

72+
73+
5274
## Web Application
5375

5476
The PyHDX web application is currently hosted at:

0 commit comments

Comments
 (0)