Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
edhartnett committed Apr 30, 2019
1 parent 4e1897e commit 3f0112f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ cdash site at [http://my.cdash.org/index.php?project=PIO](http://my.cdash.org/in

## Dependencies

PIO can use NetCDF (version 4.3.3+) and/or PnetCDF (version 1.6.0+)
PIO can use NetCDF (version 4.6.1+) and/or PnetCDF (version 1.9.0+)
for I/O. NetCDF may be built with or without netCDF-4 features. NetCDF
is required for PIO, PnetCDF is optional.

Expand All @@ -29,6 +29,19 @@ be linked with an MPI-enabled version of HDF5. Optionally, NetCDF can be
built with DAP support, which introduces a dependency on CURL. Additionally,
HDF5, itself, introduces dependencies on LIBZ and (optionally) SZIP.

## Building PIO

To build PIO, unpack the distribution tarball and do:

```
CC=mpicc FC=mpif90 ./configure --enable-fortran && make check install
```

For a full description of the available options and flags, try:
```
./configure --help
```

## Configuring with CMake

To configure the build, PIO requires CMake version 2.8.12+. The typical
Expand Down Expand Up @@ -88,7 +101,7 @@ If you wish to install PIO in a safe location for use later with other
software, you may set the `CMAKE_INSTALL_PREFIX` variable to point to the
desired install location.

## Building
### Building

Once you have successfully configured PIO with CMake in a build directory.
From within the build directory, build PIO with:
Expand All @@ -99,7 +112,7 @@ make

This will build the `pioc` and `piof` libraries.

## Testing
### Testing

If you desire to do testing, and `PIO_ENABLE_TESTS=ON` (which is the default
setting), you may build the test executables with:
Expand Down Expand Up @@ -136,7 +149,7 @@ job submission script. It is important to understand, however, that `ctest` its
will preface all of the test executable commands with the appropriate `mpirun`/`mpiexec`/`runjob`/etc.
Hence, you should not further preface the `ctest` command with these MPI launchers.

## Installing
### Installing

Once you have built the PIO libraries, you may install them in the location
specified by the `CMAKE_INSTALL_PREFIX`. To do this, simply type:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/GettingStarted.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Basic description of how to optimize IO in a parallel environment...
PIO calls are collective. A MPI communicator is set in a call to \ref
PIO_init and all tasks associated with that communicator must
participate in all subsequent calls to PIO. An application can make
multiple calls to \ref PIO_init in order to support multiple MPI
multiple calls to PIO_init() in order to support multiple MPI
communicators.

Begin by getting and unpacking the most recent release of PIO from
Expand Down

0 comments on commit 3f0112f

Please sign in to comment.