Skip to content

Commit 5b975e5

Browse files
committed
add instructions for quick install
1 parent 045f6e2 commit 5b975e5

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ scalable I/O performance.
1515
* MPI C library and Python package, [mpi4py](https://mpi4py.readthedocs.io/en/stable/install.html).
1616
* [PnetCDF C library](https://github.com/Parallel-netCDF/PnetCDF), built with shared libraries.
1717

18+
### Quick Installation
19+
* Make sure have a working MPI and pnetcdf-C software and then use pip to install pnetcdf-Python library from PyPI
20+
```
21+
CC=/path/to/mpicc PNETCDF_DIR=/path/to/pnetcdf/dir/ pip install pnetcdf
22+
```
23+
1824
### Developer Installation
1925
* Clone this GitHub repository
2026
* Required software for developer installation:

docs/source/installation/install.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ Installation
66
Quick Install
77
===================================
88

9-
Quick installation via pip install is currently unavailable as this library has not yet been uploaded to PyPI.
10-
Please follow building from source instructions provided below to set up the library.
9+
Software Requirements
10+
- PnetCDF C library (built with shared libraries) and MPI C library
11+
12+
Make sure have a working MPI and pnetcdf-C software and then use pip to install pnetcdf-Python library from PyPI
13+
.. code-block:: bash
14+
$ CC=/path/to/mpicc PNETCDF_DIR=/path/to/pnetcdf/dir/ pip install pnetcdf
1115
1216
Install from Source
1317
============================================

0 commit comments

Comments
 (0)