Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Tutorial section at the ADIOS2 readthedocs #3793

Closed
vicentebolea opened this issue Sep 5, 2023 · 5 comments · Fixed by #3880
Closed

Add Tutorial section at the ADIOS2 readthedocs #3793

vicentebolea opened this issue Sep 5, 2023 · 5 comments · Fixed by #3880
Assignees
Labels
area: documentation Documentation issues

Comments

@vicentebolea
Copy link
Collaborator

vicentebolea commented Sep 5, 2023

We want to have an tutorial sections at the ADIOS2 readthedocs adios2.readthedocs.io/.

We want the following sections

  • 00 Hello world; read/write (low level API C++)
  • 01 Reading the ADIOS2 files (From python)
  • 02 Variables usage (Low level API C++)
  • 03 Attributes (Low level API C++)
  • 04 Operators (Low level API C++)

The source code of the tutorial should be the skeleton code and its solution and should be hosted at: https://github.com/ornladios/ADIOS2-Examples/tree/master/source

More info at the ADIOS2-examples readthedocs https://adios2-examples.readthedocs.io/en/latest/

@vicentebolea
Copy link
Collaborator Author

@spyridon97 we also want each tutorial to use its own standalone cmakelists.txt. We can do this one in a later iteration it makes thing more difficult.

ref #3795

@spyridon97
Copy link
Contributor

Note for developer: Also update fides documentation to not use ADIOS2-examples

@spyridon97
Copy link
Contributor

spyridon97 commented Oct 10, 2023

After discussing we are gonna use the following examples for the tutorials

  1. HelloWorld
    1. examples/hello/helloWorld/hello-world.cpp
  2. Read/Write files
    1. examples/hello/bpWriter/bpWriter.cpp
    2. examples/hello/bpReader/bpReader.cpp
  3. Attributes:
    1. examples/hello/bpAttributesWriter.cpp
  4. Operators
    1. examples/hello/bpWriter/bpSZ.cpp
  5. Time steps:
    1. examples/hello/bpTimeWriteRead/bpTimeWriteRead.cpp

if any of them have python alternatives, they will be also attached.

@spyridon97
Copy link
Contributor

Also the draft MR that @vicentebolea created is #3791.

@vicentebolea
Copy link
Collaborator Author

  • examples/basics/GlobalArrayND/globalArrayNDWrite.cpp

  • examples/basics/JoinedArray/JoinedArrayWrite.cpp

  • examples/basics/localArray/localArrayRead/Write.cpp

Great @spyridon97, this sounds good, Please note that Scott really wants a python example/tutorial for read/write an adios2 file. We can append this in the tutorial 2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Documentation issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants