Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README #32

Merged
merged 2 commits into from
May 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![compilation](https://github.com/COSIMA/domain-tools/actions/workflows/compilation.yml/badge.svg)](https://github.com/COSIMA/domain-tools/actions/workflows/compilation.yml)

# Domain Tools

Code and tools to edit and manipulate ocean model grids and topographies.
Expand Down Expand Up @@ -124,3 +126,49 @@ double-precision topography file.

Options
* `--vgrid <vgrid>` vertical grid (default 'ocean_vgrid.nc')


# Building and Installation

## General Instructions

### Prerequisites

To compile these tools one needs:
- Fortran compiler
- netCDF-Fortran
- CMake

### Step-by-step instructions

`domain-tools` uses CMake for building and installation. Therefore the procedure
to build the sources and install the executables is fairly standard:
```console
git clone https://github.com/COSIMA/domain-tools.git
cd domain-tools
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
cmake --install build --prefix=<directory where to install the tools>
```

## Gadi

An installation of these tools is available on Gadi. To use it, you need to be a
member of group `ik11` and load the corresponding module:

```console
module use /g/data/ik11/spack/modules
module load domain-tools
```

If instead you wish to build and install the tools from the sources, you can
follow a slighly modified version of above step-be-step instructions:
```console
module load intel-compiler netcdf
export NetCDF_ROOT=$(nc-config --prefix)
git clone https://github.com/COSIMA/domain-tools.git
cd domain-tools
cmake -B build -DCMAKE_BUILD_TYPE=Release -DNetCDF_Fortran_LIBRARY=$NetCDF_ROOT/lib/Intel/libnetcdff.so -DNetCDF_C_LIBRARY=$NetCDF_ROOT/lib/libnetcdf.so -DNetCDF_Fortran_INCLUDE_DIRS=$NetCDF_ROOT/include/Intel
cmake --build build
cmake --install build --prefix=<directory where to install the tools>
```