Skip to content

Commit 978021c

Browse files
authored
Merge pull request #21 from MilagrosMarin/update_docs
chore: split `kpms` into separate optional dependencies for CPU and GPU, update README
2 parents ea902ac + adf55c8 commit 978021c

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,18 @@ DataJoint Elements collectively standardize and automate data collection and ana
2222
git clone https://github.com/<enter_github_username>/element-moseq.git
2323
```
2424

25+
+ Install [Conda](https://docs.conda.io/en/latest/miniconda.html).
26+
27+
+ Create and activate a Conda environment:
28+
```bash
29+
conda env create -f conda_env.yml
30+
conda activate element_moseq
31+
```
32+
2533
+ Install with `pip`:
2634

2735
```bash
28-
pip install -e .[keypoint-moseq]
36+
pip install -e .[kpms_cpu] # MacOS: pip install -e ".[kpms_cpu]"
2937
```
3038

3139
+ [Interactive tutorial on GitHub Codespaces](https://github.com/datajoint/element-moseq#interactive-tutorial)

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ elements = [
3434
"element-interface @ git+https://github.com/datajoint/element-interface.git",
3535
"element-animal @ git+https://github.com/datajoint/element-animal.git",
3636
]
37-
kpms = ["jax<0.7.0", "keypoint-moseq @ git+https://github.com/dattalab/keypoint-moseq.git"]
37+
kpms_cpu = ["jax<0.7.0", "keypoint-moseq @ git+https://github.com/dattalab/keypoint-moseq.git"]
38+
kpms_gpu = ["jax<0.7.0", "keypoint-moseq[cuda] @ git+https://github.com/dattalab/keypoint-moseq.git"]
39+
3840
tests = [
3941
"pytest",
4042
"pytest-cov",

0 commit comments

Comments
 (0)