Skip to content

Commit

Permalink
Some docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
williamfgc committed Nov 1, 2019
1 parent 0dd464c commit 5fd0df6
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 14 deletions.
9 changes: 7 additions & 2 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,15 @@ Please find [The ADIOS 2 User Guide at readthedocs](https://adios2.readthedocs.i

## Getting ADIOS2

* From source: [Install ADIOS 2](https://adios2.readthedocs.io/en/latest/setting_up/setting_up.html#) requires CMake v3.6 or above
* From source: [Install ADIOS 2 documentation](https://adios2.readthedocs.io/en/latest/setting_up/setting_up.html#) requires CMake v3.6 or above. For a cmake configuration example see [scripts/runconf/runconf.sh](https://github.com/ornladios/ADIOS2/blob/master/scripts/runconf/runconf.sh)


* Conda packages: [https://anaconda.org/williamfgc](https://anaconda.org/williamfgc)
* Conda packages:
* [https://anaconda.org/williamfgc](https://anaconda.org/williamfgc)
* [https://anaconda.org/conda-forge/adios2](https://anaconda.org/conda-forge/adios2)


* Spack: [adios2 package](https://spack.readthedocs.io/en/latest/package_list.html#adios2)


Once ADIOS 2 is installed refer to:
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
'setting_up/source/ctest.rst',
'setting_up/source/cpp_c.rst',
'setting_up/source.rst',
'setting_up/conda.rst',
'setting_up/package.rst',
'setting_up/linking.rst',
'api_full/fortran.rst',
'api_full/python.rst',
Expand Down
9 changes: 0 additions & 9 deletions docs/user_guide/source/setting_up/conda.rst

This file was deleted.

19 changes: 19 additions & 0 deletions docs/user_guide/source/setting_up/package.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
################
Package Managers
################

*****
Conda
*****

Currently ADIOS 2 can be obtained from anaconda cloud:

* x86-64 and MacOS: `williamfgc adios2-openmpi adios2-mpich adios2-nompi <https://anaconda.org/williamfgc>`_
* Multiple archs: `conda-forge adios2 <https://anaconda.org/conda-forge/adios2>`_


*****
Spack
*****

ADIOS 2 is fully supported in the latest Spack `adios2 package <https://spack.readthedocs.io/en/latest/package_list.html#adios2>`_
2 changes: 1 addition & 1 deletion docs/user_guide/source/setting_up/setting_up.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

.. include:: source.rst
.. include:: conda.rst
.. include:: package.rst
.. include:: linking.rst
2 changes: 1 addition & 1 deletion docs/user_guide/source/setting_up/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Install from Source
###################

ADIOS2 uses `CMake <https://cmake.org/>`_ version 3.6 or above, for building,
testing and installing the library, examples and utilities.
testing and installing the library and utilities.

.. include:: source/cmake.rst
.. include:: source/hpc_systems.rst
Expand Down

0 comments on commit 5fd0df6

Please sign in to comment.