Skip to content

Commit 1eb951f

Browse files
authored
Update README.md
1 parent 8b13986 commit 1eb951f

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,29 @@ Builds upon the WrightTools Data object.
1919

2020
### Basic
2121

22-
`pip install git+https://github.com/wright-group/make-it-wright.git`
23-
24-
If you use conda, consider making an environment for this package prior to installing:
25-
`conda create -n makeitwright pip`
22+
First download this repository and unzip it.
23+
Navigate to the package directory (the folder containing the "pyproject.toml" file).
24+
Create a conda environment for this package:
25+
```
26+
conda create -n makeitwright pip
27+
conda activate makeitwright
28+
```
29+
Still in this directory, install the package:
30+
```
31+
pip install .
32+
```
33+
If you wish to install in editable mode, use the same steps of above, but include the editable flag when installing:
34+
```
35+
pip install --editable .
36+
```
37+
38+
For whatever IDE you use (pyCharm, Spyder, VSCode), be sure to configure the editor so that you use the correct Conda environment (consult the documentation for the IDE).
2639

2740
### IonTOF
2841

2942
support for iontof data is optional; if you need to use iontof data, specify additional imports using:
3043

31-
`pip install git+https://github.com/wright-group/make-it-wright.git[iontof]`
44+
`pip install .[iontof]`
3245

3346
Note that at the time of this writing, iontof must be used on python version <3.13.
3447

0 commit comments

Comments
 (0)