Skip to content

Commit 787e6ca

Browse files
Update README.md
1 parent e76f438 commit 787e6ca

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,22 @@ While this tool is independently maintained and not officially supported by 10x
55
This can be simply installed from pip, using:
66
`pip install loupepy`
77

8+
You must run the setup function and agree to the eula. This only needs to be done once.
9+
10+
```{py}
11+
from loupepy import setup
12+
13+
setup()
14+
15+
> This tool is independently maintained, but utilizes 10x genomics tools to perform conversions
16+
> By using this tool, you agree to the 10X Genomics End User License Agreement (https://www.10xgenomics.com/legal/end-user-software-license-agreement)
17+
> Do you agree to the terms of the EULA? (yes/y or no/n)
18+
19+
y
20+
```
21+
Will install the tool to the default program install directory in your OS. A custom path for the install can also be provided, however you will need to include it in subsequent commands using the:
22+
`loupe_converter_path` argument.
23+
824
## Main Functions
925

1026
### `create_loupe_from_anndata(anndata, output_cloupe="cloupe.cloupe", layer=None, ...)`

0 commit comments

Comments
 (0)