Skip to content

Commit 02a11d6

Browse files
committed
Updated docs for conda install
1 parent 97ccec8 commit 02a11d6

File tree

5 files changed

+44
-29
lines changed

5 files changed

+44
-29
lines changed

README.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -94,27 +94,26 @@ plt.tight_layout()
9494

9595
### Installation
9696

97-
Hyperseti requires a CUDA-capable GPU and Python 3.7 or above. To install, theoretically you just type:
97+
Hyperseti uses the GPU heavily, so a working CUDA environment is needed, and
98+
requires Python 3.7 or above. hyperseti relies upon `cupy`, which is easiest to install using `conda` (or `mamba`).
99+
100+
To install from [conda/mamba package](https://anaconda.org/technosignatures/hyperseti):
98101

99102
```
100-
pip install git+https://github.com/ucberkeleyseti/hyperseti
103+
conda install -c technosignatures hyperseti
101104
```
102105

103-
hyperseti relies upon `cupy`, which is easiest to install using `conda` (or `mamba`). If starting from scratch, this should get you most of the way there:
106+
If starting from scratch, this should get you most of the way there:
104107

105108
```
106-
conda create -n hyper -c nvidia -c conda-forge python=3.10 cudatoolkit=11.3 cupy jupyterlab ipywidgets
109+
conda create -n hyper -c nvidia -c conda-forge python=3.10 cupy jupyterlab ipywidgets
107110
```
108111

109-
Where `cudatoolkit=XX` should match your installed CUDA version. Jupyterlab and ipywidgets are optional, but useful for a base environment.
112+
Jupyterlab and ipywidgets are optional, but useful for a base environment.
110113

111114
From there:
115+
112116
```
113117
conda activate hyper
114-
git clone https://github.com/UCBerkeleySETI/hyperseti
115-
cd hyperseti
116-
pip install -r requirements.txt
117-
pip install -r requirements_test.txt
118-
pip install -r docs/requirements.txt
119-
pip install .
118+
pip install git+https://github.com/ucberkeleyseti/hyperseti
120119
```

conda-recipe/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Conda recipes
2+
3+
Recipe for building conda package. From the repository root directory, run:
4+
5+
```
6+
conda-build conda-recipe -c conda-forge
7+
```
8+
9+
Upload to [anaconda/technosignatures](https://anaconda.org/technosignatures/hyperseti) channel:
10+
11+
```
12+
anaconda login
13+
anaconda upload --user technosignatures /home/dancpr/conda-bld/linux-64/hyperseti-1.0.0-0.tar.bz2
14+
```
15+
16+

conda-recipe/meta.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ requirements:
2727
{% for dep in requirements["dependencies"] %}
2828
- {{ dep.lower() }}
2929
{% endfor %}
30-
3130
test:
3231
requires:
3332
{% for dep in requirements["test"] %}

docs/usage/quickstart.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,28 @@
22

33
### Installation
44

5-
Theoretically, just type:
5+
hyperseti uses the GPU heavily, so a working CUDA environment is needed, and
6+
requires Python 3.7 or above. hyperseti relies upon `cupy`, which is easiest to install using `conda` (or `mamba`).
7+
8+
To install from conda/mamba package:
69

710
```
8-
pip install git+https://github.com/ucberkeleyseti/hyperseti
11+
conda install -c technosignatures hyperseti
912
```
1013

11-
hyperseti uses the GPU heavily, so a working CUDA environment is needed, and
12-
requires Python 3.7 or above. hyperseti relies upon `cupy`, which is easiest to install using `conda` (or `mamba`). If starting from scratch, this should get you most of the way there:
14+
If starting from scratch, this should get you most of the way there:
1315

1416
```
15-
conda create -n hyper -c nvidia -c conda-forge python=3.10 cudatoolkit=11.3 cupy jupyterlab ipywidgets
17+
conda create -n hyper -c nvidia -c conda-forge python=3.10 cupy jupyterlab ipywidgets
1618
```
1719

18-
Where `cudatoolkit=XX` should match your installed CUDA version. Jupyterlab and ipywidgets are optional, but useful for a base environment.
20+
Jupyterlab and ipywidgets are optional, but useful for a base environment.
1921

2022
From there:
23+
2124
```
2225
conda activate hyper
23-
git clone https://github.com/UCBerkeleySETI/hyperseti
24-
cd hyperseti
25-
pip install -r requirements.txt
26-
pip install -r requirements_test.txt
27-
pip install -r docs/requirements.txt
28-
pip install .
26+
pip install git+https://github.com/ucberkeleyseti/hyperseti
2927
```
3028

3129

requirements.yaml

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
name: hyperseti
22
channels:
33
- conda-forge
4+
- nvidia
45
dependencies:
56
- cupy
6-
- cutensor
7-
- jupyterlab
8-
- ipywidgets
97
- h5py
10-
- hdf5plugin
118
- numpy
129
- scipy
1310
- pandas
1411
- matplotlib
15-
- logbook
1612
- astropy
1713
- pyyaml
14+
- hdf5plugin
15+
- logbook
1816
test:
1917
- pytest
18+
- coverage
2019
- pytest-cov
2120
- pytest-runner
2221
- pytest-order
2322
- codecov
2423
build:
2524
- python
2625
- poetry
26+
docs:
27+
- sphinx
28+
- sphinx-rtd-theme
29+
- myst-parser

0 commit comments

Comments
 (0)