diff --git a/docs/uenv-overview.md b/docs/uenv-overview.md new file mode 100644 index 00000000..cf02cabd --- /dev/null +++ b/docs/uenv-overview.md @@ -0,0 +1,14 @@ +# Supported UENV on Alps + +On Alps CSCS provides supported uenv that serve different application and development environment use cases. + +The list of supported uenv on a specific Alps system (`eiger`, `clariden`, `santis` etc) is documented in the [CSCS knowledge base](https://confluence.cscs.ch/display/KB/User+Guides). +Please read the knowledge base documentaiton for more details on specific systems. + +These pages here present detailed documentation for each of the officially supported UENV. + +* CP2K is provided by [`cp2k`](uenv-cp2k.md) +* GROMACS is provided by [`gromacs`](uenv-gromacs.md) +* Linaro Forge is provided by [`linaro-forge`](uenv-linaro-forge.md) +* NAMD is provided by [`namd`](uenv-namd.md) +* Quantum Espresso is provided by [`quantumespresso`](uenv-qe.md) diff --git a/mkdocs.yml b/mkdocs.yml index 81bf2c19..57deb379 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,11 +2,12 @@ site_name: alps-uenv nav: - Home: index.md - 'uenv': - - 'CP2K `cp2k`': uenv-cp2k.md - - 'GROMACS `gromacs`': uenv-gromacs.md - - 'Linaro Forge `linaro-forge`': uenv-linaro-forge.md - - 'NAMD `namd`': uenv-namd.md - - 'Qantum ESPRESSO `quantumespresso`': uenv-qe.md + - 'Overview': uenv-overview.md + - 'cp2k': uenv-cp2k.md + - 'gromacs': uenv-gromacs.md + - 'linaro-forge': uenv-linaro-forge.md + - 'namd': uenv-namd.md + - 'quantumespresso': uenv-qe.md - 'Packaging': - 'tutorial: application': pkg-application-tutorial.md theme: