Skip to content

Commit 0e0f29c

Browse files
committed
Add conda-forge release information to the docs
Closes #1489
1 parent 9cc3597 commit 0e0f29c

1 file changed

Lines changed: 25 additions & 7 deletions

File tree

docs/src/site/pages/netcdfJava/developer/CdmUtilityPrograms.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ permalink: cdm_utility_programs.html
77
---
88

99
Below are useful command-line utilities that can be called from the CDM library.
10-
The easiest way to use these is to grab the latest netcdfAll.jar file.
10+
One way to use these tools is to grab the latest netcdfAll.jar or toolsUI.jar file from the [Unidata downloads page](https://downloads.unidata.ucar.edu/netcdf-java/){:target="_blank"} or the [netCDF-Java GitHub releases page](https://github.com/Unidata/netcdf-java/releases){:target="_blank"}.
11+
However, a super handy [community-led effort](https://github.com/conda-forge/netcdf-java-feedstock){:target="_blank"} makes JAR management and a set of convenient wrapper scripts (`.sh` and `.bat`) available through `conda-forge`:
12+
13+
```bash
14+
conda install -c conda-forge netcdf-java
15+
```
16+
17+
## Utilities
1118

1219
* [ncdump](#ncdump): prints the textual representation of a dataset to standard output
1320
* [nccopy](#nccopy): copies a CDM dataset to a netCDF-3 (default) or netCDF-4 file
@@ -17,7 +24,6 @@ The easiest way to use these is to grab the latest netcdfAll.jar file.
1724
* [CFPointWriter](#cfpointwriter): copies a CDM point feature dataset to CF/NetCDF format
1825
* [GribCdmIndex](#gribcdmindex): write GRIB Collection Indexes
1926
* [FeatureScan](#featurescan): scans a directory to find CDM datasets and determines their FeatureTypes
20-
* [NetcdfDataset](#netcdfdataset): copies a NetcdfFile object, or parts of one, to a netcdf-3 or netcdf-4 disk file
2127
* [ToolsUI](#toolsui): Netcdf Tools user interface
2228

2329
## ncdump
@@ -42,6 +48,7 @@ where:
4248
* `-v varName1;varName2;..`: show data for these variables, use variable’s full names (including groups if present)
4349
* `-v varName(0:1,:,12)`: show data for a section of this variable only, using FORTRAN 90 section specification
4450

51+
The conda wrapper script is named `ncj-ncdump`.
4552

4653
## nccopy
4754

@@ -88,6 +95,8 @@ java -Xmx1g -classpath netcdfAll-<version>.jar ucar.nc2.write.Nccopy [options]
8895
Default: false
8996
~~~
9097

98+
The conda wrapper script is named `ncj-nccopy`.
99+
91100
## nccompare
92101

93102
Compares two [CDM files](file_types.html) for semantic equivalence.
@@ -103,6 +112,8 @@ where
103112
* `file1`: first file to compare
104113
* `file2`: second file to compare
105114

115+
The conda wrapper script is named `ncj-nccompare`.
116+
106117
## BufrSplitter
107118

108119
Copies a BUFR file\'s messages into separate output files, depending on message type.
@@ -116,6 +127,8 @@ where
116127
* `--fileSpec`: file to split
117128
* `--dirOut`: output directory of split operation
118129

130+
The conda wrapper script is named `ncj-bufrsplitter`.
131+
119132
## CFPointWriter
120133

121134
Copies a CDM point feature dataset to CF/NetCDF format.
@@ -150,6 +163,8 @@ java -Xmx1g -classpath netcdfAll-<version>.jar ucar.nc2.ft.point.writer.CFPointW
150163
Default: false
151164
~~~
152165

166+
The conda wrapper script is named `ncj-cfpointwriter`.
167+
153168
## GribCdmIndex
154169

155170
Write GRIB Collection Indexes from an XML file containing a [GRIB `<featureCollection>`](grib_feature_collections_ref.html) XML element.
@@ -175,11 +190,13 @@ java -Xmx1g -classpath netcdfAll-<version>.jar ucar.nc2.grib.collection.GribCdmI
175190

176191
Note that the output file is placed in the root directory of the collection, as specified by the [Collection Specification string](https://docs.unidata.ucar.edu/tds/current/userguide/collection_spec_string_ref.html){:target="_blank"} of the GRIB [`<featureCollection>`](grib_feature_collections_ref.html).
177192

193+
The conda wrapper script is named `ncj-gribcdmindex`.
194+
178195
## FeatureScan
179196

180197
Scans all the files in a directory to see if they are [CDM files](file_types.html) and can be identified as a particular feature type.
181198

182-
~~~basj
199+
~~~bash
183200
java -Xmx1g -classpath netcdfAll-<version>.jar ucar.nc2.ft.scan.FeatureScan directory [-subdirs]
184201
~~~
185202

@@ -188,6 +205,8 @@ where
188205
* `directory`: scan this directory
189206
* `-subdirs`: recurse into subdirectories
190207

208+
The conda wrapper script is named `ncj-featurescan`.
209+
191210
## CatalogCrawler
192211

193212
Crawl a catalog, optionally open datasets to look for problems.
@@ -260,13 +279,12 @@ count fail = 3
260279
count failException = 0
261280
~~~
262281

263-
## NetcdfDataset
264-
265-
Use [nccopy](#nccopy) instead.
282+
The conda wrapper script is named `ncj-catalogcrawler`.
266283

267284
## ToolsUI
268285

269286
~~~bash
270-
java -Xmx8g -jar netcdfAll-<version>.jar
287+
java -Xmx8g -jar toolsUI-<version>.jar
271288
~~~
272289

290+
The conda wrapper script is named `ncj-toolsui`.

0 commit comments

Comments
 (0)