Skip to content

add instructions for quick install #60

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 13, 2024
Merged

add instructions for quick install #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b975e5
add instructions for quick install
Jonathanlyj Nov 12, 2024
7adcf00
fixed typo in instructions
Jonathanlyj Nov 12, 2024
d0da5d3
update MPICH version to 4.2.2 in github actions
Jonathanlyj Nov 12, 2024
c2f9d1e
modified user guide
Jonathanlyj Nov 12, 2024
0ea8f79
MPICH 4.2.2 is required when using mpi4py 4.0
wkliao Nov 13, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/pnetcdf_c_master.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pnetcdf_c_official.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 8 additions & 2 deletions docs/source/installation/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
============================================
Expand Down
Loading