diff --git a/.github/workflows/pnetcdf_c_master.yml b/.github/workflows/pnetcdf_c_master.yml index 4429e75..e7b2699 100644 --- a/.github/workflows/pnetcdf_c_master.yml +++ b/.github/workflows/pnetcdf_c_master.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest timeout-minutes: 60 env: - MPICH_VERSION: 4.2.0 + MPICH_VERSION: 4.2.2 MPICH_DIR: ${{ github.workspace }}/mpich-install PNETCDF_VERSION: repo PNETCDF_DIR: ${{ github.workspace }}/PnetCDF-install diff --git a/.github/workflows/pnetcdf_c_official.yml b/.github/workflows/pnetcdf_c_official.yml index 7749f82..c09d4cd 100644 --- a/.github/workflows/pnetcdf_c_official.yml +++ b/.github/workflows/pnetcdf_c_official.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest timeout-minutes: 60 env: - MPICH_VERSION: 4.2.0 + MPICH_VERSION: 4.2.2 MPICH_DIR: ${{ github.workspace }}/mpich-install PNETCDF_VERSION: 1.13.0 PNETCDF_DIR: ${{ github.workspace }}/PnetCDF-install diff --git a/README.md b/README.md index ae1b755..9574ec5 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,19 @@ scalable I/O performance. ### Software Dependencies * Python 3.9 or later. * [numpy](http://www.numpy.org/) Python package. -* MPI C library and Python package, [mpi4py](https://mpi4py.readthedocs.io/en/stable/install.html). -* [PnetCDF C library](https://github.com/Parallel-netCDF/PnetCDF), built with shared libraries. +* MPI C library and Python package, + [mpi4py](https://mpi4py.readthedocs.io/en/stable/install.html). + + Note when using mpi4py 4.0 and MPICH, MPICH version 4.2.2 and later is + required. +* [PnetCDF C library](https://github.com/Parallel-netCDF/PnetCDF), built with + shared libraries. + +### Quick Installation +* Make sure you have a working MPI and PnetCDF-C software installed. +* Run pip command below to install PnetCDF-Python library from PyPI: + ``` + CC=/path/to/mpicc PNETCDF_DIR=/path/to/pnetcdf/dir/ pip install pnetcdf + ``` ### Developer Installation * Clone this GitHub repository diff --git a/docs/source/installation/install.rst b/docs/source/installation/install.rst index 0b9d954..37f6345 100644 --- a/docs/source/installation/install.rst +++ b/docs/source/installation/install.rst @@ -6,8 +6,14 @@ Installation Quick Install =================================== -Quick installation via pip install is currently unavailable as this library has not yet been uploaded to PyPI. -Please follow building from source instructions provided below to set up the library. +Software Requirements + - PnetCDF C library (built with shared libraries) and MPI C library + +Install PnetCDF-python library from PyPI + .. code-block:: bash + + $ CC=/path/to/mpicc PNETCDF_DIR=/path/to/pnetcdf/dir/ pip install pnetcdf + Install from Source ============================================