You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
When those are installed within your environment, _then_ you can install Herbie with pip.
37
+
For pip users:
27
38
28
39
```bash
29
40
# Install last published version
@@ -34,18 +45,17 @@ To install the full functionality in the library which includes
34
45
[xarray accessors](https://github.com/blaylockbk/Herbie/blob/main/src/herbie/accessors.py) for plotting and data manipulation, please install the "extras" dependencies:
35
46
36
47
```bash
37
-
# Install last published version
38
48
pip install 'herbie-data[extras]'
39
49
```
40
50
41
-
The code can also be installed directly from github.
51
+
The latest updates code can be installed directly from GitHub:
If you are developing Herbie, you might want to do something like this:
49
59
50
60
```bash
51
61
# Clone and install editable source code
@@ -54,16 +64,23 @@ cd Herbie
54
64
pip install -e .
55
65
```
56
66
57
-
## uv install
67
+
---
58
68
59
-
You can add Herbie to your [uv](https://docs.astral.sh/uv/) project with:
69
+
## Optional Software: wgrib2
60
70
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
63
77
```
64
78
65
-
Herbie CLI tools can be installed with
79
+
Alternatively, you can install in a conda environment:
Copy file name to clipboardExpand all lines: docs/user_guide/tutorial/wgrib2-wrapper.ipynb
+12-3Lines changed: 12 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,19 @@
7
7
"source": [
8
8
"# 🎁 Wrapper for `wgrib2`\n",
9
9
"\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",
11
11
"\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."
0 commit comments