Skip to content

Commit

Permalink
Merge pull request #2559 from dmitry-ganyushin/doc
Browse files Browse the repository at this point in the history
Updated documentation
  • Loading branch information
dmitry-ganyushin authored Dec 22, 2020
2 parents 2cd80c7 + 06e2c9a commit 7854b5f
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 6 deletions.
40 changes: 35 additions & 5 deletions docs/user_guide/source/api_full/fortran.rst
Original file line number Diff line number Diff line change
Expand Up @@ -518,22 +518,52 @@ 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
* :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
-------------------------
Expand Down
30 changes: 29 additions & 1 deletion docs/user_guide/source/api_full/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

0 comments on commit 7854b5f

Please sign in to comment.