@@ -9,11 +9,12 @@ classic formats. The software development is a collaborative work of
99Northwestern University and Argonne National Laboratory.
1010
1111* The original repository: https://svn.mcs.anl.gov/repos/parallel-netcdf
12- * Since June 1, 2018, PnetCDF repository has been migrated to
13- here, https://github.com/Parallel-NetCDF/PnetCDF , on github.com .
12+ * Since June 1, 2018, the PnetCDF repository has been migrated to
13+ here on github.
1414
15- ### PnetCDF project web page
15+ ### PnetCDF project home page
1616* https://parallel-netcdf.github.io
17+ contains more information about PnetCDF.
1718
1819### PnetCDF official software releases
1920* All ** official released versions** can be found in
@@ -27,36 +28,38 @@ Northwestern University and Argonne National Laboratory.
2728### Build PnetCDF using source codes of this development repository
2829* The source codes in this repository are constantly under development. They
2930 should ** NOT** be used for production runs.
30- * Use the source codes in this repository only if you are interested in
31- contributing the project and we welcome and appreciate any contribution.
32- * To clone this repository, run command
31+ * Building PnetCDF using the source codes in this repository only if you are
32+ interested in contributing the project and we welcome and appreciate any
33+ contribution.
34+ * Required software
35+ + MPI compilers, e.g. [ MPICH] ( https://www.mpich.org ) and
36+ [ OpenMPI] ( https://www.open-mpi.org )
37+ + [ autoconfig] ( https://www.gnu.org/software/autoconf ) version 2.70
38+ + [ automake] ( https://www.gnu.org/software/automake ) version 1.16.5
39+ + [ libtool] ( https://www.gnu.org/software/libtool ) version 2.4.6
40+ + [ m4] ( https://www.gnu.org/software/m4 ) version 1.4.17
41+ * Clone, build, and installation commands:
3342 ``` console
3443 git clone https://github.com/Parallel-NetCDF/PnetCDF.git
35- ```
36- This will create a new folder named ` PnetCDF ` .
37- * Before running configure command to build PnetCDF, please run commands below
38- first.
39- ``` console
44+
4045 cd PnetCDF
4146 autoreconf -i
47+
48+ ./configure --prefix=/install/path --with-mpi=/mpi/path
49+ make install
4250 ```
43- Several files, e.g. configure and Makefile.in, will be created for running the
44- configure command. The minimum versions of GNU autotools required are:
45- + [ autoconfig] ( https://www.gnu.org/software/autoconf/autoconf.html ) version 2.70
46- + [ automake] ( https://www.gnu.org/software/automake ) version 1.16.5
47- + [ libtool] ( https://www.gnu.org/software/libtool ) version 2.4.6
48- + [ m4] ( https://www.gnu.org/software/m4/m4.html ) version 1.4.17
4951
5052### Build instructions and recipes
5153* Please read file [ INSTALL] ( ./INSTALL ) for build instructions. There are also
5254 several build recipes under folder [ doc] ( ./doc#readme ) for a few popular
5355 systems.
5456
55- ### PnetCDF user guides
57+ ### Users documents
5658* [ C API references] ( https://parallel-netcdf.github.io/doc/c-reference/pnetcdf-c/index.html )
5759* [ Questions & Answers] ( https://parallel-netcdf.github.io/doc/faq.html )
60+ * [ Utility Programs] ( ./src/utils#readme )
5861* [ NetCDF4 vs. PnetCDF] ( ./doc/netcdf4_vs_pnetcdf.md )
59- * [ PnetCDF blocking vs. non-blocking APIs] ( ./doc/blocking_vs_nonblocking.md )
62+ * PnetCDF [ blocking vs. non-blocking APIs] ( ./doc/blocking_vs_nonblocking.md )
6063
6164### Mailing List
6265@@ -65,6 +68,16 @@ Northwestern University and Argonne National Laboratory.
6568 + The past discussions in the mailing list are available in:
6669 http://lists.mcs.anl.gov/pipermail/parallel-netcdf/ .
6770
71+ ### External links to some related projects and application users
72+ * [ PnetCDF Python] ( https://github.com/Parallel-NetCDF/PnetCDF-Python ) ,
73+ a python interface to PnetCDF library.
74+ * [ E3SM I/O kernel study] ( https://github.com/Parallel-NetCDF/E3SM-IO )
75+ * [ Scorpio] ( https://github.com/E3SM-Project/scorpio ) , the I/O module of E3SM.
76+ * [ PIO] ( https://github.com/NCAR/ParallelIO ) - parallel I/O library at NCAR.
77+ * [ WRF] ( https://github.com/wrf-model/WRF/tree/master/external/io_pnetcdf )
78+ - Weather Research & Forecasting Model at NCAR.
79+
80+
6881### Acknowledgements
6982* Ongoing development and maintenance of PnetCDF-python is supported by the
7083 U.S. Department of Energy's Office of Science, Scientific Discovery through
0 commit comments