Skip to content

Commit 5320ed4

Browse files
committed
rewording README.md
1 parent 4e2c331 commit 5320ed4

1 file changed

Lines changed: 20 additions & 24 deletions

File tree

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,41 @@
1-
# PnetCDF python
1+
# PnetCDF for Python
22
![](https://img.shields.io/badge/python-v3.9-blue)
33
![](https://img.shields.io/badge/tests%20passed-49-brightgreen)
44
![](https://readthedocs.org/projects/pnetcdf-python/badge/?version=latest)
55

6-
PnetCDF-python is a Python interface to
7-
[PnetCDF](https://parallel-netcdf.github.io/), a high-performance parallel I/O
8-
library for accessing netCDF files.
9-
This package allows Python users to access netCDF data using the rich ecosystem
10-
of Python's scientific computing libraries, making it a valuable tool for
11-
applications that require parallel access to netCDF files.
6+
PnetCDF-Python is a Python interface to
7+
[PnetCDF](https://parallel-netcdf.github.io/), a high-performance I/O library
8+
for accessing netCDF files in parallel. It can provide MPI-based parallel
9+
python programs to achieve a scalable I/O performance.
1210

1311
### Software Dependencies
14-
* Python 3.9 or above
15-
* MPI libraries
12+
* Python 3.9 or later.
13+
* [numpy](http://www.numpy.org/) Python package.
14+
* MPI C library and Python package, [mpi4py](https://mpi4py.readthedocs.io/en/stable/install.html).
1615
* PnetCDF [C library](https://github.com/Parallel-netCDF/PnetCDF), built with shared libraries.
17-
* Python library [mpi4py](https://mpi4py.readthedocs.io/en/stable/install.html)
18-
* Python library [numpy](http://www.numpy.org/)
1916

2017
### Developer Installation
2118
* Clone this GitHub repository
22-
* Make sure the above dependent software are installed.
23-
* In addition, [Cython](http://cython.org/), [packaging](https://pypi.org/project/packaging/), [setuptools>=65](https://pypi.org/project/setuptools/) and [wheel](https://pypi.org/project/wheel/) are required for developer installation.
24-
* Set the environment variable `PNETCDF_DIR` to PnetCDF's installation path.
25-
* Make sure utility program `pnetcdf-config` is available in `$PNETCDF_DIR/bin`.
26-
* Run command below to install.
19+
* Required software for developer installation:
20+
+ The above mentioned dependent software are installed and additionally,
21+
+ [Cython](http://cython.org/), [packaging](https://pypi.org/project/packaging/), [setuptools>=65](https://pypi.org/project/setuptools/) and [wheel](https://pypi.org/project/wheel/).
22+
* Commands to install.
2723
```
28-
CC=/path/to/mpicc PNETCDF_DIR=/path/to/pnetcdf/dir pip install --no-build-isolation -e .
24+
export CC=/path/to/mpicc
25+
export PNETCDF_DIR=/path/to/pnetcdf/dir
26+
pip install --no-build-isolation -e .
2927
```
30-
* Testing
31-
+ Run command `"make check"` to test all the programs available in folders
32-
["test/"](./test) and ["examples/"](./examples) in parallel on 4 MPI
33-
processes.
34-
+ In addition, command `"make ptests"` runs the same tests using 3, 4, and 8
35-
MPI processes.
28+
* Testing -- Command `"make check"` tests all the programs available in folders
29+
["test/"](./test) and ["examples/"](./examples).
3630

3731
### Additional Resources
32+
* [Example programs](./examples#pnetcdf-python-examples) are available in
33+
folder `./examples`.
3834
* PnetCDF-python [User Guide](https://pnetcdf-python.readthedocs.io/en/latest)
3935
* [Data objects](docs/pnetcdf_objects.md) in PnetCDF python programming
4036
* [Comparison](docs/nc4_vs_pnetcdf.md) of NetCDF4-python and PnetCDF-python
4137
* [PnetCDF project home page](https://parallel-netcdf.github.io)
42-
* [PnetCDF repository of C/Fortran library](https://github.com/Parallel-NetCDF/PnetCDF)
38+
* [PnetCDF of C/Fortran library repository](https://github.com/Parallel-NetCDF/PnetCDF)
4339

4440
### Developer Team
4541
* Youjia Li <<youjia@northwestern.edu>>

0 commit comments

Comments
 (0)