-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add/Improve the ReadMe.md files in examples directory
- Loading branch information
1 parent
f1a0864
commit c1ba1c5
Showing
19 changed files
with
323 additions
and
138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # ADIOS2 Examples | ||
|
|
||
| This directory contains examples of how to use ADIOS2 in different scenarios. | ||
| The examples are written mostly in C++, but also C, Fortran, Python, and Julia. | ||
|
|
||
| They can be found in the following subdirectories, and they should be explored in the order that they are listed: | ||
|
|
||
| 1. [hello](hello): The _hello_ examples are meant to introduce you to ADIOS2's IO capabilities and engines. | ||
| 2. [basics](basics): The _basics_ examples are meant to introduce you to basic concepts of ADIOS2, such as | ||
| global/joined/local arrays, values, and variables shapes. | ||
| 3. [useCases](useCases): The _useCases_ examples are meant to demonstrate how to use ADIOS2 in different scenarios, | ||
| such as in situ visualization, and fides schema. | ||
| 4. [plugins](plugins): The _plugins_ examples are meant to introduce you to the plugin capabilities of ADIOS2, such as | ||
| how to develop your own engine or operators. | ||
| 5. [simulations](simulations): The _simulations_ examples are meant to demonstrate how to integrate ADIOS2 within your | ||
| simulation code to read, write and/or stream your simulation data. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| ## ADIOS2 basics examples | ||
|
|
||
| The _basics_ examples are meant to introduce you to basic concepts of ADIOS2, such as | ||
| global/joined/local arrays, values, and variables shapes. | ||
|
|
||
| They can be found in the following subdirectories, and they should be explored in the order that they are listed: | ||
|
|
||
| 1. [globalArray1D](globalArray1D): The _globalArray1D_ example demonstrates how to read and write an | ||
| 1-D global array with constant dimensions over time from multiple processors using ADIOS2's BP engine. | ||
| * Languages: C, Fortran | ||
| 2. [globalArrayND](globalArrayND): The _globalArrayND_ example demonstrates how to write an N-D global array with | ||
| constant dimensions over time from multiple processors using ADIOS2's BP engine. | ||
| * Languages: C++ | ||
| 3. [localArray](localArray): The _localArray_ example demonstrates how to write and read a local array per processor | ||
| with the same name from multiple processors using ADIOS2's BP engine. | ||
| * Languages: C++ | ||
| 4. [joinedArray](joinedArray): The _joinedArray_ example demonstrates how to write local array that is different only in | ||
| one dimension so that it can be joined into a global array with the same name from multiple processors at read time | ||
| using ADIOS2's ADIOS2's BP engine. | ||
| * Languages: C++ | ||
| 5. [values](values): The _values_ example demonstrates how to write and read a multiple types of variables with a single | ||
| value, such as global constant, global value, local constant, and local value using ADIOS2's BP engine. | ||
| * Languages: C++, Fortran | ||
| 6. [variablesShapes](variablesShapes): The _variablesShapes_ example demonstrates how to write supported variables | ||
| shapes using stepping and ADIOS2's BP engine. | ||
| * Languages: C++, C++ using high-level API | ||
| 7. [queryWorker](queryWorker): The _queryWorker_ example demonstrates how to read variables using ADIOS2's BP engine | ||
| and perform queries on the read data and streams the results. | ||
| * Languages: C++ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| ## ADIOS2 hello examples | ||
|
|
||
| The _hello_ examples are meant to introduce you to ADIOS2's IO capabilities and engines. | ||
|
|
||
| They can be found in the following subdirectories, and they should be explored in the order that they are listed: | ||
|
|
||
| 1. [helloWorld](helloWorld): The _helloWorld_ example demonstrates how to write a simple word and read it back using | ||
| ADIOS2's BP engine. | ||
| * Languages: C++, C++ using high-level API, C, Python, Python using high-level API | ||
| 2. [bpWriter](bpWriter): The _bpWriter_ examples demonstrate how to write a variable to using ADIOS2's BP engine. | ||
| * Languages: C++, C, Fortran, Python | ||
| 3. [bpReader](bpReader): The _bpReader_ examples demonstrate how to read a 1D/2D/3D variable using ADIOS2's BP engine. | ||
| * Languages: C++, Fortran, Python | ||
| 4. [bpFWriteCRead](bpFWriteCRead): The _bpFWriteCRead_ example demonstrates how to write a 2D variable with Fortran and | ||
| read a subset of it with C++, and vice versa using ADIOS2's BP engine. | ||
| * Languages: C++, Fortran | ||
| 5. [bpTimeWriter](bpTimeWriter): The _bpTimeWriter_ example demonstrates how to write two Variables (one is timestep) | ||
| using time aggregation using ADIOS2's BP engine. | ||
| * Languages: C++, Python | ||
| 6. [bpAttributeWriter](bpAttributeWriter): The _bpAttributeWriter_ example demonstrates how to write attributes using | ||
| ADIOS2's BP engine. | ||
| * Languages: C++ | ||
| 7. [bpFlushWriter](bpFlushWriter): The _bpFlushWriter_ example demonstrates how to flush a variable using ADIOS2's BP | ||
| engine. | ||
| * Languages: C++ | ||
| 8. [bpWriteReadCuda](bpWriteReadCuda): The _bpWriteReadCuda_ example demonstrates how to write and read a variable with | ||
| multiple time steps using ADIOS2's BP engine and leveraging CUDA. | ||
| * Languages: C++ | ||
| 9. [bpWriteReadHip](bpWriteReadHip): The _bpWriteReadHip_ example demonstrates how to write and read a variable with | ||
| multiple time steps using ADIOS2's BP engine and leveraging HIP. | ||
| * Languages: C++ | ||
| 10. [bpWriteReadKokkos](bpWriteReadKokkos): The _bpWriteReadOmp_ example demonstrates how to write and read a variable | ||
| with multiple time steps using ADIOS2's BP engine and leveraging Kokkos. | ||
| * Languages: C++ | ||
| 11. [datamanReader](datamanReader): The _datamanReader_ example demonstrates how to read variables in real-time WAN | ||
| streams using ADIOS's DataMan engine. | ||
| * Languages: C++, Python | ||
| 12. [datamanWriter](datamanWriter): The _datamanWriter_ example demonstrates how to write variables in real-time WAN | ||
| streams using ADIOS's DataMan engine. | ||
| * Languages: C++, Python | ||
| 13. [dataspacesReader](dataspacesReader): The _dataspacesReader_ example demonstrates how to read a variable using | ||
| ADIOS2's DATASPACES engine. | ||
| * Languages: C++ | ||
| 14. [dataspacesWriter](dataspacesWriter): The _dataspacesWriter_ example demonstrates how to write a variable using | ||
| ADIOS2's DATASPACES engine. | ||
| * Languages: C++ | ||
| 15. [hdf5Reader](hdf5Reader): The _hdf5Reader_ example demonstrates how to read variables using ADIOS2's HDF5 engine. | ||
| * Languages: C++ | ||
| 16. [hdf5Writer](hdf5Writer): The _hdf5Writer_ example demonstrates how to write variables using ADIOS2's HDF5 engine. | ||
| * Languages: C++ | ||
| 17. [hdf5SubFile](hdf5SubFile): The _hdf5SubFile_ example demonstrates how to write variables using ADIOS2's parallel | ||
| HDF5 engine leveraging the subfile feature. | ||
| * Languages: C++ | ||
| 18. [inlineMWE](inlineMWE): The _inlineMWE_ example demonstrates how to write and read a variable using ADIOS2's inline | ||
| engine. | ||
| * Languages: C++ | ||
| 19. [inlineFWriteCppRead](inlineFWriteCppRead): The _inlineFWriteCppRead_ example demonstrates how to write a 2D | ||
| variable with Fortran and read it back a subset of it with C++ using ADIOS2's inline engine. | ||
| * Languages: C++, Fortran | ||
| 20. [inlineReaderWriter](inlineReaderWriter): The _inlineReaderWriter_ example demonstrates how to write two Variables | ||
| (one is timestep) using time aggregation and ADIOS2's inline engine. | ||
| * Languages: C++ | ||
| 21. [sstReader](sstReader): The _sstReader_ example demonstrates how to read a variable using ADIOS2's SST engine. | ||
| * Languages: C++ | ||
| 22. [sstWriter](sstWriter): The _sstWriter_ example demonstrates how to write a variable using ADIOS2's SST engine. | ||
| * Languages: C++ | ||
| 23. [skeleton](skeleton): The _skeleton_ example demonstrates how to write and read a variable using an ADIOS2 skeleton | ||
| engine. | ||
| * Languages: C++ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| ## ADIOS2 plugins examples | ||
|
|
||
| The _plugins_ examples are meant to introduce you to the plugin capabilities of ADIOS2, such as | ||
| how to develop your own engine or operators. | ||
|
|
||
| They can be found in the following subdirectories, and they should be explored in the order that they are listed: | ||
|
|
||
| 1. [engine](engine): The _engine_ example demonstrates how to develop the read/write capabilities of your ADIOS2 engine | ||
| and use it to read and write variables. | ||
| * Languages: C++ | ||
| 2. [operator](operator): The _operator_ example demonstrates how to read and write variables using the | ||
| ADIOS2/plugins/operators/EncryptionOperator and ADIOS2's BP engine. | ||
| * Languages: C++ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| ## ADIOS2 simulations examples | ||
|
|
||
| The _simulations_ examples are meant to demonstrate how to integrate ADIOS2 within your | ||
| simulation code to read, write and/or stream your simulation data. | ||
|
|
||
| They can be found in the following subdirectories, and they should be explored in the order that they are listed: | ||
|
|
||
| 1. [korteweg-de-vries](korteweg-de-vries): The _korteweg-de-vries_ example demonstrates how to solve the initial value | ||
| problem for the Korteweg de-Vries equation via the Zabusky and Krustal scheme and integrate ADIOS2 for its IO | ||
| capabilities. | ||
| * Languages: C++, Python | ||
| 2. [lorenz_ode](lorenz_ode): The _lorenz_ode_ example demonstrates how to solve the Lorenz system of ordinary | ||
| differential equations and integrate ADIOS2 for its IO capabilities. | ||
| * Languages: C++ | ||
| 3. [gray-scott](gray-scott): The _gray-scott_ example demonstrates how to perform simulation with the Gray-Scott | ||
| reaction diffusion model and integrate ADIOS2 for its IO capabilities. | ||
| * Languages: C++ | ||
| 4. [gray-scott-struct](gray-scott-struct): The _gray-scott-struct_ example demonstrates how to perform a simulation with | ||
| the Gray-Scott reaction diffusion model using a struct that defines user defined data types and integrate ADIOS2 for | ||
| its IO capabilities. | ||
| * Languages: C++ | ||
| 5. [gray-scott-kokkos](gray-scott-kokkos): The _gray-scott-kokkos_ example demonstrates how to perform a simulation with | ||
| the Gray-Scott reaction diffusion model using Kokkos and integrate ADIOS2 for its IO capabilities. | ||
| * Languages: C++ | ||
| 6. [GrayScott.jl](GrayScott.jl): The _GrayScott.jl_ example demonstrates how to perform a simulation with the Gray-Scott | ||
| reaction diffusion model and integrate ADIOS2 for its IO capabilities. | ||
| * Languages: Julia | ||
| 7. [heatTransfer](heatTransfer): The _heatTransfer_ example demonstrates how to solve a 2D Poisson equation for | ||
| temperature in homogeneous media using finite differences and integrate ADIOS2 for its IO capabilities. | ||
| * Languages: C++ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ### ADIOS2 gray-scott-kokkos example | ||
|
|
||
| This is a 3D 7-point stencil code to simulate the following [Gray-Scott | ||
| reaction diffusion model](https://doi.org/10.1126/science.261.5118.189): | ||
|
|
||
| #### Differences from the gray-scott example | ||
|
|
||
| It uses Kokkos to run the simulation on GPU. | ||
| Please use the installed Gray-Scott example directory but run adios2_simulations_gray-scott-kokkos binary. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.