Skip to content

Commit 1aa0fde

Browse files
committed
update install instructions
1 parent 619f31b commit 1aa0fde

2 files changed

Lines changed: 47 additions & 21 deletions

File tree

docs/user_guide/install.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# 🐍 Installation
22

3-
## conda install
3+
There are so many ways to install stuff. Pick the one that fits your workflow.
4+
5+
## Install with conda/mamba
46

57
[![Conda](https://img.shields.io/conda/v/conda-forge/herbie-data)](https://anaconda.org/conda-forge/herbie-data)
68

7-
The easiest way to install Herbie and its dependencies is with [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) from conda-forge.
9+
For conda/mamba users:
810

911
```bash
1012
mamba install -c conda-forge herbie-data
@@ -14,16 +16,25 @@ mamba install -c conda-forge herbie-data
1416
conda install -c conda-forge herbie-data
1517
```
1618

17-
## pip install
19+
## Install with uv
1820

19-
[![PyPI - Version](https://img.shields.io/pypi/v/herbie-data)](https://pypi.org/project/herbie-data/)
21+
For [uv](https://docs.astral.sh/uv/) users, add herbie as project dependency:
22+
23+
```bash
24+
uv add herbie-data
25+
```
2026

21-
Herbie is published on PyPI and you can install it with pip, _but_ it requires some dependencies that you will have to install yourself:
27+
The Herbie CLI may be installed as a tool:
2228

23-
- Python 3.10+
24-
- _Optional:_ [wgrib2](https://anaconda.org/conda-forge/wgrib2)
29+
```bash
30+
uv tool install herbie-data
31+
```
32+
33+
## Install with pip
34+
35+
[![PyPI - Version](https://img.shields.io/pypi/v/herbie-data)](https://pypi.org/project/herbie-data/)
2536

26-
When those are installed within your environment, _then_ you can install Herbie with pip.
37+
For pip users:
2738

2839
```bash
2940
# Install last published version
@@ -34,18 +45,17 @@ To install the full functionality in the library which includes
3445
[xarray accessors](https://github.com/blaylockbk/Herbie/blob/main/src/herbie/accessors.py) for plotting and data manipulation, please install the "extras" dependencies:
3546

3647
```bash
37-
# Install last published version
3848
pip install 'herbie-data[extras]'
3949
```
4050

41-
The code can also be installed directly from github.
51+
The latest updates code can be installed directly from GitHub:
4252

4353
```bash
4454
# Install current main branch
4555
pip install git+https://github.com/blaylockbk/Herbie.git
4656
```
4757

48-
or
58+
If you are developing Herbie, you might want to do something like this:
4959

5060
```bash
5161
# Clone and install editable source code
@@ -54,16 +64,23 @@ cd Herbie
5464
pip install -e .
5565
```
5666

57-
## uv install
67+
---
5868

59-
You can add Herbie to your [uv](https://docs.astral.sh/uv/) project with:
69+
## Optional Software: wgrib2
6070

61-
```bash
62-
uv add herbie-data
71+
Herbie provides some very basic, limited wrappers for [wgrib2](https://wgrib2-docs.readthedocs.io/en/latest/). For Linux or Mac users, the easiest way to install wgrib2 is from [conda-forge](https://anaconda.org/channels/conda-forge/packages/wgrib2/overview).
72+
73+
I recommend installing wgrib2 globally with [Pixi](https://pixi.sh/latest/):
74+
75+
```
76+
pixi global install wgrib2
6377
```
6478

65-
Herbie CLI tools can be installed with
79+
Alternatively, you can install in a conda environment:
6680

67-
```bash
68-
uv tool install herbie-data
81+
```
82+
mamba install wgrib2
83+
```
84+
```
85+
conda install wgrib2
6986
```

docs/user_guide/tutorial/wgrib2-wrapper.ipynb

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,19 @@
77
"source": [
88
"# 🎁 Wrapper for `wgrib2`\n",
99
"\n",
10-
"Herbie provides a very basic wrapper for wgrib2. Note that the **wgrbi2** functionality requires **wgrib2** is in your path (it can be installed via conda on Linux), and it can only perform actions on _local_ grib2 files.\n",
10+
"Herbie provides a very basic wrapper for wgrib2. Note that the **wgrbi2** functionality requires **wgrib2** is in your path. Note that wgrib2 can only perform actions on _local_ GRIB2 files, not remote files.\n",
1111
"\n",
12-
"> Note: I attempted to open-source and re-publish the wgrib2 docs here: https://wgrib2-docs.readthedocs.io/en/latest/ \n",
13-
"> (these are _unofficial_ wgrib2 docs)."
12+
"## Install wgrib2\n",
13+
"\n",
14+
"For Linux or Mac, the easiest way to install wgrib2 is installing from [conda-forge](https://anaconda.org/search?q=wgrib2). My preferred method is with [Pixi](https://pixi.sh/latest/):\n",
15+
"\n",
16+
"```bash\n",
17+
"pixi global install wgrib2\n",
18+
"```\n",
19+
"\n",
20+
"## Unofficial wgrib2 docs\n",
21+
"\n",
22+
"I attempted to re-publish [wgrib2 docs (unofficial)](https://wgrib2-docs.readthedocs.io/en/latest/) that may or may not be helpful to you."
1423
]
1524
},
1625
{

0 commit comments

Comments
 (0)