Skip to content

Commit afbb709

Browse files
committed
Add link to docs & update installation instructions in README.md
1 parent 4b9623b commit afbb709

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,16 @@
11
# OceanDataStore
22

3+
[**Documentation**](https://noc-msm.github.io/OceanDataStore/)
4+
35
A Python library designed to streamline writing, updating & accessing ocean model and observational data stored in cloud object storage.
46

57
## Installation
68

7-
To install the **OceanDataStore** package, first clone the repository from GitHub:
8-
9-
```bash
10-
git clone git@github.com:NOC-MSM/OceanDataStore.git
11-
```
12-
13-
Next, install **OceanDataStore** in editable mode as follows:
14-
15-
```bash
16-
cd OceanDataStore
9+
We recommend downloading and installing **OceanDataStore** into a new virtual environment via GitHub.
1710

18-
pip install -e .
11+
After activating a new virtual environment, pip install **OceanDataStore** from GitHub:
12+
```{bash}
13+
pip install git+https://github.com/NOC-MSM/OceanDataStore.git
1914
```
2015

2116
**Note:** we strongly recommend installing **OceanDataStore** into a new virtual environment using either ``venv`` or ``conda / mamba``.

0 commit comments

Comments
 (0)