Skip to content

Commit

Permalink
Added python full interface description.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitry-ganyushin committed Dec 22, 2020
1 parent 427135e commit 06e2c9a
Showing 1 changed file with 29 additions and 1 deletion.
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 06e2c9a

Please sign in to comment.