diff --git a/CMakeLists.txt b/CMakeLists.txt index a37cf5dfe3..c50239e83c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -7,7 +7,7 @@ message(STATUS "===== Configuring SCORPIO... =====") # The project version number. set(VERSION_MAJOR 1 CACHE STRING "Project major version number.") set(VERSION_MINOR 9 CACHE STRING "Project minor version number.") -set(VERSION_PATCH 0 CACHE STRING "Project patch version number.") +set(VERSION_PATCH 2 CACHE STRING "Project patch version number.") mark_as_advanced(VERSION_MAJOR VERSION_MINOR VERSION_PATCH) #============================================================================== diff --git a/docs/html/_c_a_mexample.html b/docs/html/_c_a_mexample.html index c5b9538797..af1c02346b 100644 --- a/docs/html/_c_a_mexample.html +++ b/docs/html/_c_a_mexample.html @@ -1,9 +1,9 @@ - +
- - + +|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
| ▼Mpio_types | |
| Cdecompmap_t | |
| Cfile_desc_t | File descriptor returned by PIO_openfile or PIO_createfile (see pio_types) |
| Cio_desc_t | An io descriptor handle that is generated in PIO_initdecomp (see pio_types) |
| Ciosystem_desc_t | A defined PIO system descriptor created by PIO_init (see pio_types) |
| Cpio_rearr_comm_fc_opt_t | |
| Cpio_rearr_opt_t | |
| Cvar_desc_t | A variable descriptor returned from PIO_def_var (see pio_types) |
| ▼Mpioexample | |
| Cpioexampleclass | A class to hold example code and data |
| Cfile_desc_t | File descriptor structure |
| Cio_desc_t | IO descriptor structure |
| Cio_region | IO region structure |
| ▼Ciosystem_desc_t | IO system descriptor structure |
| Casync_ios_msg_info_ | Async I/O service message info |
| Crearr_comm_fc_opt | Rearranger comm flow control options |
| Crearr_opt | Rearranger options |
| Cvar_desc_t | Variable description structure |
| Cwmulti_buffer | The multi buffer holds data from one or more variables |
| ▼Npio_types | |
| Cdecompmap_t | |
| Ciosystem_desc_t | A defined PIO system descriptor created by PIO_init (see pio_types) |
| Cfile_desc_t | File descriptor returned by PIO_openfile or PIO_createfile (see pio_types) |
| Cio_desc_t | An io descriptor handle that is generated in PIO_initdecomp (see pio_types) |
| Cvar_desc_t | A variable descriptor returned from PIO_def_var (see pio_types) |
| Cpio_rearr_comm_fc_opt_t | |
| Cpio_rearr_opt_t | |
| ▼Npioexample | |
| Cpioexampleclass | A class to hold example code and data |
| ▼Nspio_decomp_cint | |
| CPIOc_readmap_from_f90 | |
| CPIOc_writemap_from_f90 | |
| ▼Nspio_init | |
| Cpio_get_numiotasks | Get the number of I/O processes/tasks in an I/O subsystem |
| ▼Nspio_init_cint | |
| CPIOc_iosystem_is_active | |
| CPIOc_iotask_rank | |
| CPIOc_iam_iotask | |
| CPIOc_get_numiotasks | |
| CPIOc_set_hint | |
| CPIOc_set_blocksize | |
| Cfile_desc_t | File descriptor structure |
| Cio_desc_t | IO descriptor structure |
| Cio_region | IO region structure |
| ▼Ciosystem_desc_t | IO system descriptor structure |
| Casync_ios_msg_info_ | Async I/O service message info |
| Crearr_comm_fc_opt | Rearranger comm flow control options |
| Crearr_opt | Rearranger options |
| Cvar_desc_t | Variable description structure |
| Cwmulti_buffer | The multi buffer holds data from one or more variables |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
The user API is closely related to the NetCDF API. Please refer to http://www.unidata.ucar.edu/software/netcdf/docs for more information on NetCDF APIs. The SCORPIO API is listed below:
@@ -157,7 +151,7 @@|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
#include <getopt.h>
+Macros#define | TEST_NAME "darray_async" | | #define | NUM_NETCDF_FLAVORS 4 | | #define | NDIM3 3 | | #define | NUM_TIMESTEPS 2 | | #define | DIM_LEN_X 4 | | #define | DIM_LEN_Y 4 | | #define | VAR_NAME "foo" | | #define | ERR_BAD 1001 | | #define | START_DATA_VAL 42 | | #define | TARGET_NTASKS 5 | | #define | LOG_LEVEL 3 | | #define | NUM_IO_TASKS 1 | | #define | NUM_COMP_TASKS 4 | | #define | COMPONENT_COUNT 1 | | #define | MPIERR(e) | | #define | ERR(e) | | #define | TEST_NAME "darray_async" | #define | NUM_NETCDF_FLAVORS 4 | #define | NDIM3 3 | #define | NUM_TIMESTEPS 2 | #define | DIM_LEN_X 4 | #define | DIM_LEN_Y 4 | #define | VAR_NAME "foo" | #define | ERR_BAD 1001 | #define | START_DATA_VAL 42 | #define | TARGET_NTASKS 5 | #define | LOG_LEVEL 3 | #define | NUM_IO_TASKS 1 | #define | NUM_COMP_TASKS 4 | #define | COMPONENT_COUNT 1 | #define | MPIERR(e) | #define | ERR(e) | ||||||||||||||||||||
+Functionsint | main (int argc, char *argv[]) | | int | main (int argc, char *argv[]) | |||||
+Variablesint | dim_len [NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} | | char | dim_name [NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} | | char | err_buffer [MPI_MAX_ERROR_STRING] | | int | resultlen | | int | dim_len [NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} | char | dim_name [NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} | char | err_buffer [MPI_MAX_ERROR_STRING] | int | resultlen | ||||||||
| int dim_len[NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} | +int dim_len[NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} |
| char dim_name[NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} | +char dim_name[NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
#include <getopt.h>
+Macros#define | NUM_NETCDF_FLAVORS 4 | | #define | NDIM3 3 | | #define | NUM_TIMESTEPS 2 | | #define | DIM_LEN_X 4 | | #define | DIM_LEN_Y 4 | | #define | VAR_NAME "foo" | | #define | ERR_BAD 1001 | | #define | START_DATA_VAL 42 | | #define | TARGET_NTASKS 4 | | #define | LOG_LEVEL 3 | | #define | MPIERR(e) | | #define | ERR(e) | | #define | NUM_NETCDF_FLAVORS 4 | #define | NDIM3 3 | #define | NUM_TIMESTEPS 2 | #define | DIM_LEN_X 4 | #define | DIM_LEN_Y 4 | #define | VAR_NAME "foo" | #define | ERR_BAD 1001 | #define | START_DATA_VAL 42 | #define | TARGET_NTASKS 4 | #define | LOG_LEVEL 3 | #define | MPIERR(e) | #define | ERR(e) | ||||||||||||||||
+Functionsint | check_file (int iosysid, int ntasks, char *filename, int iotype, int elements_per_pe, int my_rank, int ioid) | | int | main (int argc, char *argv[]) | | int | check_file (int iosysid, int ntasks, char *filename, int iotype, int elements_per_pe, int my_rank, int ioid) | int | main (int argc, char *argv[]) | ||||||
+Variablesint | dim_len [NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} | | char | dim_name [NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} | | char | err_buffer [MPI_MAX_ERROR_STRING] | | int | resultlen | | int | dim_len [NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} | char | dim_name [NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} | char | err_buffer [MPI_MAX_ERROR_STRING] | int | resultlen | ||||||||
| int dim_len[NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} | +int dim_len[NDIM3] = {NC_UNLIMITED, DIM_LEN_X, DIM_LEN_Y} |
| char dim_name[NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} | +char dim_name[NDIM3][PIO_MAX_NAME+1] = {"unlimted", "x", "y"} |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
One of the advantages of using SCORPIO is the ability to describe the way data is decomposed across compute processes and reusing it for reading and writing any data that uses the same decomposition. Another major advantage is the feature in SCORPIO to rearrange data before using low level I/O libraries like NetCDF and PnetCDF to write data to disk.
@@ -108,7 +102,7 @@|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
| File in scorpio3/examples | Includes file in scorpio3/src |
|---|---|
| c / darray_async.c | clib / pio.h |
| c / darray_no_async.c | clib / pio.h |
| c / example1.c | clib / pio.h |
| c / example2.c | clib / pio.h |
| c / examplePio.c | clib / pio.h |
| c / netcdf4p.c | clib / pio.h |
| c / put_var.c | clib / pio.h |
| c / test_adios.c | clib / pio.h |
| c / test_hdf5.c | clib / pio.h |
| File in scorpio5/examples | Includes file in scorpio5/src |
|---|---|
| c / darray_async.c | clib / pio.h |
| c / darray_no_async.c | clib / pio.h |
| c / example1.c | clib / pio.h |
| c / example2.c | clib / pio.h |
| c / examplePio.c | clib / pio.h |
| c / netcdf4p.c | clib / pio.h |
| c / put_var.c | clib / pio.h |
| c / test_adios.c | clib / pio.h |
| c / test_hdf5.c | clib / pio.h |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
| File in scorpio3/examples/c | Includes file in scorpio3/src |
|---|---|
| darray_async.c | clib / pio.h |
| darray_no_async.c | clib / pio.h |
| example1.c | clib / pio.h |
| example2.c | clib / pio.h |
| examplePio.c | clib / pio.h |
| netcdf4p.c | clib / pio.h |
| put_var.c | clib / pio.h |
| test_adios.c | clib / pio.h |
| test_hdf5.c | clib / pio.h |
| File in scorpio5/examples/c | Includes file in scorpio5/src |
|---|---|
| darray_async.c | clib / pio.h |
| darray_no_async.c | clib / pio.h |
| example1.c | clib / pio.h |
| example2.c | clib / pio.h |
| examplePio.c | clib / pio.h |
| netcdf4p.c | clib / pio.h |
| put_var.c | clib / pio.h |
| test_adios.c | clib / pio.h |
| test_hdf5.c | clib / pio.h |
|
- SCORPIO 1.9.0
-
- |
-

-Files | |
| darray_async.c | |
| darray_no_async.c | |
| example1.c | |
| A simple C example for the ParallelIO Library. | |
| example2.c | |
| A simple C example for the ParallelIO Library. | |
| examplePio.c | |
| A simple C example for the ParallelIO Library. | |
| netcdf4p.c | |
| put_var.c | |
| A simple C example for the ParallelIO Library using PIOc_put_vara() | |
| test_adios.c | |
| test_hdf5.c | |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|

+Directories | CMakeFiles | | directory | CMakeFiles | |||||
+Files | dtypes.h | | | pio_kinds.F90 | | | spio_darray.F90 | | | spio_darray_cint.F90 | | | spio_decomp.F90 | | | spio_get_att.F90 | | | spio_get_att_cint.F90 | | | spio_get_var.F90 | | | spio_get_var_cint.F90 | | | spio_put_att.F90 | | | spio_put_att_cint.F90 | | | spio_put_var.F90 | | | spio_put_var_cint.F90 | | file | dtypes.h [code] | file | pio_kinds.F90 | basic data types | file | spio_darray.F90 | APIs for reading and writing distributed arrays. | file | spio_darray_cint.F90 | C Interfaces for APIs to read and write distributed arrays. | file | spio_decomp.F90 | Miscellaneous SCORPIO APIs This file contains the SCORPIO APIs initialize and free I/O decompositions This file also includes misc APIs related to I/O decompositions. | file | spio_get_att.F90 | SCORPIO APIs for writing attributes This file contains the SCORPIO APIs for reading ("get"ting) attributes (metadata) associated with variables. | file | spio_get_att_cint.F90 | C Interfaces for SCORPIO APIs to get/read variable attributes (scalars & arrays) associated with a variable from a file. | file | spio_get_var.F90 | SCORPIO APIs for reading non-distributed arrays This file contains the SCORPIO APIs for reading ("get"ting) non-distributed arrays. | file | spio_get_var_cint.F90 | C Interfaces for SCORPIO APIs to get/read non-distributed arrays into a file. | file | spio_put_att.F90 | SCORPIO APIs for writing attributes This file contains the SCORPIO APIs for writing ("put"ting) attributes (metadata) associated with variables. | file | spio_put_att_cint.F90 | C Interfaces for SCORPIO APIs to put/write variable attributes (scalars & arrays) associated with a variable into a file. | file | spio_put_var.F90 | SCORPIO APIs for writing non-distributed arrays This file contains the SCORPIO APIs for writing ("put"ting) non-distributed arrays. | file | spio_put_var_cint.F90 | C Interfaces for SCORPIO APIs to put/write non-distributed arrays into a file. | |||||||||||||||||||||||||||||
|
+ SCORPIO
+ 1.9.2
+
+ |
+
|
+ SCORPIO
+ 1.9.2
+
+ |
+

+Directories | |
| directory | docs |
| directory | examples |
| directory | src |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
-
- |
-
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
Close a file. -
-Close a file.
-| [in,out] | file | The handle to the file being closed. File descriptor structure. |
This structure holds information associated with each open file
| ierr | (Optional) The return value |
|
- SCORPIO 1.9.0
-
- |
-

-Files | |
| examplePio.f90 | |
| A simple Fortran example for the ParallelIO Library. | |
|
- SCORPIO 1.9.0
-
- |
-
|
- SCORPIO 1.9.0
-
- |
-

|
- SCORPIO 1.9.0
-
- |
-

|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
|
- SCORPIO 1.9.0
-
- |
-

-Files | |
| pio.h | |
| Public headers for the PIO C interface. | |
|
+ SCORPIO
+ 1.9.2
+
+ |
+
+Files | |
| file | examplePio.f90 |
| A simple Fortran example for the ParallelIO Library. | |
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|

+Files | pio.F90 | | | pio_nf_utils.F90 | | | pio_types.F90 | | | spio_decomp_cint.F90 | | | spio_def_dim.F90 | | | spio_def_dim_cint.F90 | | | spio_def_file.F90 | | | spio_def_file_cint.F90 | | | spio_def_var.F90 | | | spio_def_var_cint.F90 | | | spio_err.F90 | | | spio_err_cint.F90 | | | spio_file.F90 | | | spio_file_cint.F90 | | | spio_init.F90 | | | spio_init_cint.F90 | | | spio_inq_att.F90 | | | spio_inq_att_cint.F90 | | | spio_inq_dim.F90 | | | spio_inq_dim_cint.F90 | | | spio_inq_file.F90 | | | spio_inq_file_cint.F90 | | | spio_inq_var.F90 | | | spio_inq_var_cint.F90 | | | spio_misc_api.F90 | | | spio_misc_api_cint.F90 | | | spio_netcdf_types.F90 | | | spio_util.F90 | | | spio_util_cint.F90 | | file | pio.F90 | User interface Module for PIO, this is the only file a user program should 'use'. | file | pio_nf_utils.F90 | Miscellaneous SCORPIO Util APIs This file contains the SCORPIO Utility APIs that built on top of other SCORPIO APIs This file also includes misc APIs for copying variables and attributes across files. | file | pio_types.F90 | Derived datatypes and constants for PIO Fortran API. | file | spio_decomp_cint.F90 | C Interfaces for SCORPIO APIs to initialize/finalize an I/O subsystem. | file | spio_def_dim.F90 | SCORPIO APIs for defining dimensions This file contains the SCORPIO APIs for defining variable dimensions. | file | spio_def_dim_cint.F90 | C Interfaces for SCORPIO APIs for defining variable dimensions. | file | spio_def_file.F90 | SCORPIO APIs for entering/exiting define mode This file contains the SCORPIO APIs for entering/exiting the define mode for a file. | file | spio_def_file_cint.F90 | C Interfaces for SCORPIO APIs for entering/exiting "define" mode in an output file. | file | spio_def_var.F90 | SCORPIO APIs for defining variables This file contains the SCORPIO APIs for inquiring about attribute (id, type, dimensions etc) | file | spio_def_var_cint.F90 | C Interfaces for SCORPIO APIs for defining variable dimensions. | file | spio_err.F90 | APIs for handling errors This file contains the APIs for handling errors in the Fortran interface. | file | spio_err_cint.F90 | C Interfaces for APIs that handle error codes. | file | spio_file.F90 | APIs related to files (open, close etc) | file | spio_file_cint.F90 | C Interfaces for APIs that handle error codes. | file | spio_init.F90 | SCORPIO APIs for initializing and finalizing the library This file contains the SCORPIO APIs for initializing and finalizing the SCORPIO I/O sub systems (corresponding to MPI communicators). | file | spio_init_cint.F90 | C Interfaces for SCORPIO APIs to initialize/finalize an I/O subsystem. | file | spio_inq_att.F90 | SCORPIO APIs for inquiring attributes This file contains the SCORPIO APIs for inquiring about attribute (id, type, dimensions etc) | file | spio_inq_att_cint.F90 | C Interfaces for SCORPIO APIs for inquiring an attribute. | file | spio_inq_dim.F90 | SCORPIO APIs for inquiring variables This file contains the SCORPIO APIs for inquiring about variable (id, type, dimensions etc) | file | spio_inq_dim_cint.F90 | C Interfaces for SCORPIO APIs for inquiring a dimension. | file | spio_inq_file.F90 | SCORPIO APIs for inquiring variables This file contains the SCORPIO APIs for inquiring about variable (id, type, dimensions etc) | file | spio_inq_file_cint.F90 | C Interfaces for SCORPIO APIs for inquiring a file. | file | spio_inq_var.F90 | SCORPIO APIs for inquiring variables This file contains the SCORPIO APIs for inquiring about variable (id, type, dimensions etc) | file | spio_inq_var_cint.F90 | C Interfaces for SCORPIO APIs for inquiring a variable. | file | spio_misc_api.F90 | Miscellaneous SCORPIO APIs This file contains the miscellaneous SCORPIO APIs. | file | spio_misc_api_cint.F90 | C Interfaces for miscellaneous SCORPIO APIs. | file | spio_netcdf_types.F90 | Utilities functions This file contains constants/types specific to the NetCDF library. | file | spio_util.F90 | Utilities functions This file contains the utilities used by the Fortran Interface. | file | spio_util_cint.F90 | C Interfaces for miscellaneous util SCORPIO APIs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
- SCORPIO 1.9.0
-
- |
-

-Directories | |
| docs | |
| examples | |
| src | |
|
+ SCORPIO
+ 1.9.2
+
+ |
+

+Directories | |
| directory | c |
| directory | f03 |
|
+ SCORPIO
+ 1.9.2
+
+ |
+

+Files | |
| file | darray_async.c |
| file | darray_no_async.c |
| file | example1.c |
| A simple C example for the ParallelIO Library. | |
| file | example2.c |
| A simple C example for the ParallelIO Library. | |
| file | examplePio.c |
| A simple C example for the ParallelIO Library. | |
| file | netcdf4p.c |
| file | put_var.c |
| A simple C example for the ParallelIO Library using PIOc_put_vara() | |
| file | test_adios.c |
| file | test_hdf5.c |
|
+ SCORPIO
+ 1.9.2
+
+ |
+
|
- SCORPIO 1.9.0
-
- |
-
|
- SCORPIO 1.9.0
+
+ |
SCORPIO
+ 1.9.2
|
Sets the limit for the internal buffer used to cache data written by the user. -
-Sets the limit for the internal buffer used to cache data written by the user.
-| [in] | limit | The new buffer limit (in bytes) |
| [out] | prev_limit | Optional parameter that returns the previous/old buffer limit (in bytes) |
+Directories | |
| directory | source |
|
- SCORPIO 1.9.0
-
- |
-
|
+ SCORPIO
+ 1.9.2
+
+ |
+
+Directories | |
| directory | piof.dir |