Skip to content

Commit 99e398b

Browse files
authored
Update README to point to pre-built binary pkgs (#94)
* Update README to point to pre-built binary pkgs * Update README.md
1 parent 8f7524b commit 99e398b

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,46 @@ Mon. Weather Rev., 144, 1529-1549, doi: 10.1175/MWR-D-15-0301.1.
2525
[![Install with conda](https://anaconda.org/conda-forge/tempest-remap/badges/installer/conda.svg)](https://anaconda.org/conda-forge/tempest-remap)
2626
[![Platforms](https://anaconda.org/conda-forge/tempest-remap/badges/platforms.svg)]()
2727

28+
Prebuilt Conda and Julia Packages
29+
----------------------------------
30+
Prebuilt binary packages for x64 Linux and MacOS are provided through conda-forge for [conda](https://docs.conda.io/en/latest/) projects and as a Julia [JLL](https://docs.binarybuilder.org/stable/jll/) package.
31+
32+
For Conda:
33+
34+
> conda install -c conda-forge tempest-remap
35+
> GenerateCSMesh --res 6 --file cubedsphere_6.netcdf --out_format NetCDF4
36+
Parameters:
37+
--res <integer> [6]
38+
--file <string> ["cubedsphere_6.netcdf"]
39+
--out_format <string> ["Netcdf4"]
40+
--alt <bool> [false]
41+
=========================================================
42+
..Generating mesh with resolution [6]
43+
..Writing mesh to file [cubedsphere_6.netcdf]
44+
Nodes per element
45+
..Block 1 (4 nodes): 216
46+
..Mesh generator exited successfully
47+
=========================================================
48+
49+
For Julia (v1.7+):
50+
51+
julia> using Pkg; Pkg.add("TempestRemap_jll")
52+
julia> using TempestRemap_jll
53+
54+
julia> run(`$(TempestRemap_jll.GenerateCSMesh_exe()) --res 6 --file cubedsphere_6.netcdf --out_format Netcdf4`);
55+
Parameters:
56+
--res <integer> [6]
57+
--file <string> ["cubedsphere_6.netcdf"]
58+
--out_format <string> ["Netcdf4"]
59+
--alt <bool> [false]
60+
=========================================================
61+
..Generating mesh with resolution [6]
62+
..Writing mesh to file [cubedsphere_6.netcdf]
63+
Nodes per element
64+
..Block 1 (4 nodes): 216
65+
..Mesh generator exited successfully
66+
=========================================================
67+
2868
Build Instructions with Autotools
2969
----------------------------------
3070

0 commit comments

Comments
 (0)