From 5c95e8aa3f1fa2d134e4fdb754e33665b427b6cc Mon Sep 17 00:00:00 2001 From: dmitry-ganyushin Date: Tue, 22 Dec 2020 11:32:00 -0500 Subject: [PATCH 1/3] Fixed description for adios2_set_steps_selection fortran function. --- docs/user_guide/source/api_full/fortran.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user_guide/source/api_full/fortran.rst b/docs/user_guide/source/api_full/fortran.rst index 201de0ef2d..5d5f1885f3 100644 --- a/docs/user_guide/source/api_full/fortran.rst +++ b/docs/user_guide/source/api_full/fortran.rst @@ -518,21 +518,21 @@ ADIOS2 Fortran bindings handlers are mapped 1-to-1 to the ADIOS components descr .. code-block:: fortran - subroutine adios2_set_selection(variable, ndims, start_dims, count_dims, ierr) + subroutine adios2_set_selection(variable, step_start, step_count, ierr) ! WHERE ! variable handler type(adios2_variable), intent(in) :: variable - ! number of dimensions in start_dims and count_dims - integer, intent(in):: ndims - ! new step_start integer(kind=8), intent(in):: step_start ! new step_count (or number of steps to read from step_start) integer(kind=8), intent(in):: step_count + + ! error code + integer, intent(out) :: ierr :ref:`Engine` subroutines From 427135eeebc67e6df2f36e88bf348b88007765e4 Mon Sep 17 00:00:00 2001 From: dmitry-ganyushin Date: Tue, 22 Dec 2020 12:20:55 -0500 Subject: [PATCH 2/3] Added description for adios2_attribute_data fortran functions. --- docs/user_guide/source/api_full/fortran.rst | 32 ++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/user_guide/source/api_full/fortran.rst b/docs/user_guide/source/api_full/fortran.rst index 5d5f1885f3..a425f8f1e0 100644 --- a/docs/user_guide/source/api_full/fortran.rst +++ b/docs/user_guide/source/api_full/fortran.rst @@ -533,7 +533,37 @@ ADIOS2 Fortran bindings handlers are mapped 1-to-1 to the ADIOS components descr ! error code integer, intent(out) :: ierr - + +* :f90:`subroutine adios2_attribute_data` Retrieve attribute data + + .. code-block:: fortran + + subroutine adios2_attribute_data(data, attribute, ierr) + + ! WHERE + + ! data handler + character*(*), intent(out):: data + real, intent(out):: data + real(kind=8), intent(out):: data + integer(kind=1), intent(out):: data + integer(kind=2), intent(out):: data + integer(kind=4), intent(out):: data + integer(kind=8), intent(out):: data + character*(*), dimension(:), intent(out):: data + real, dimension(:), intent(out):: data + real(kind=8), dimension(:), intent(out):: data + integer(kind=2), dimension(:), intent(out):: data + integer(kind=4), dimension(:), intent(out):: data + integer(kind=8), dimension(:), intent(out):: data + + + ! attribute + type(adios2_attribute), intent(in):: attribute + + ! error code + integer, intent(out) :: ierr + :ref:`Engine` subroutines ------------------------- From 06e2c9a0046caeb3f990fe4db3dbd6ca28194ca8 Mon Sep 17 00:00:00 2001 From: dmitry-ganyushin Date: Tue, 22 Dec 2020 14:55:21 -0500 Subject: [PATCH 3/3] Added python full interface description. --- docs/user_guide/source/api_full/python.rst | 30 +++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/user_guide/source/api_full/python.rst b/docs/user_guide/source/api_full/python.rst index 87f3701045..69fb38cf6d 100644 --- a/docs/user_guide/source/api_full/python.rst +++ b/docs/user_guide/source/api_full/python.rst @@ -7,5 +7,33 @@ Python bindings Product Application Developers targeting finer-level control for their IO tasks for optimization should use the current full APIs. If you want to use ADIOS2 in simple use cases (*e.g.* reading a file for analysis, interactive Python, or saving some data for a small project) please refer to the :ref:`High-Level APIs` for a flat learning curve. The full Python APIs follow very closely the full C++11 API interface. -This section is Work In Progress, we recommend Python users start with the :ref:`High-Level APIs`. +ADIOS class +-------------- +.. autoclass:: adios2::ADIOS + :members: + +IO class +-------------- +.. autoclass:: adios2::IO + :members: + +Variable class +-------------- +.. autoclass:: adios2::Variable + :members: + +Attribute class +--------------- +.. autoclass:: adios2::Attribute + :members: + +Engine class +-------------- +.. autoclass:: adios2::Engine + :members: + +Operator class +-------------- +.. autoclass:: adios2::Operator + :members: