diff --git a/docs/source/index.rst b/docs/source/index.rst index e4c9d7b94d..4ada1b5428 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -114,39 +114,56 @@ To the topics - .. grid-item-card:: :fa:`cogs;mr-1` API Reference + .. grid-item-card:: :fa:`sitemap;mr-1` Internal Architecture :text-align: center :shadow: md - Comprehensive documentation of CLI, Python API and REST API. + Detailed information on AiiDA's design and architecture. +++++++++++++++++++++++++++++++++++++++++++++ - .. button-ref:: reference/index + .. button-ref:: internals/index :ref-type: doc :click-parent: :expand: :color: primary :outline: - To the reference guide + To the architecture guide - .. grid-item-card:: :fa:`sitemap;mr-1` Internal Architecture + .. grid-item-card:: :fa:`puzzle-piece;mr-1` Core plugins :text-align: center :shadow: md - Detailed information on AiiDA's design and architecture. + Commonly used AiiDA plugins to extend core functionality +++++++++++++++++++++++++++++++++++++++++++++ - .. button-ref:: internals/index + .. button-ref:: reference/core_plugins :ref-type: doc :click-parent: :expand: :color: primary :outline: - To the architecture guide + To the plugin overview + + .. grid-item-card:: :fa:`cogs;mr-1` API Reference + :text-align: center + :shadow: md + + Comprehensive documentation of CLI, Python API and REST API. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-ref:: reference/index + :ref-type: doc + :click-parent: + :expand: + :color: primary + :outline: + + To the reference guide ------------------------------ @@ -172,8 +189,9 @@ tutorials/index howto/index topics/index - reference/index internals/index + reference/core_plugins + reference/index =========== How to cite diff --git a/docs/source/reference/core_plugins.rst b/docs/source/reference/core_plugins.rst new file mode 100644 index 0000000000..949945b315 --- /dev/null +++ b/docs/source/reference/core_plugins.rst @@ -0,0 +1,135 @@ +.. _reference:core_plugins: + +============ +Core plugins +============ + +This page lists common AiiDA plugins which are not specific to any research domain, but extend the core functionality: + +.. grid:: 1 2 2 4 + :gutter: 3 + + .. grid-item-card:: AiiDA WorkGraph + :text-align: center + :shadow: md + + Efficiently design and manage flexible workflows with AiiDA. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-workgraph + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA shell + :text-align: center + :shadow: md + + Plugin that makes running shell commands easy. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/sphuber/aiida-shell + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA submission controller + :text-align: center + :shadow: md + + Classes to help managing large numbers of submissions. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-submission-controller/ + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA hyperqueue + :text-align: center + :shadow: md + + Plugin for the HyperQueue metascheduler enabling sub-node jobs. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-hyperqueue + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA project + :text-align: center + :shadow: md + + AiiDA project manager with custom Python environments and isolated project directories. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-project + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA code registry + :text-align: center + :shadow: md + + Registry of simulation codes and computers for easy setup in AiiDA. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-code-registry + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA plugin cutter + :text-align: center + :shadow: md + + Cookie cutter recipe for AiiDA plugins. + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-plugin-cutter + :color: primary + :outline: + + Go to GitHub + + .. grid-item-card:: AiiDA PythonJob + :text-align: center + :shadow: md + + Run non-AiiDA Python functions on a remote computer (pre-alpha). + + +++++++++++++++++++++++++++++++++++++++++++++ + + .. button-link:: https://github.com/aiidateam/aiida-pythonjob + :color: primary + :outline: + + Go to GitHub + + +Honorable mentions +=================== + +- `aiida-firecrest `_: Transport/Scheduler plugins for interfacing with + FirecREST (RESTful services gateway and interface for managing HPC resources). +- `aiida-resource-registry `_: Registry of simulation codes and computers for easy setup in AiiDAlab. +- `aiida-restapi `_: RESTful AiiDA Web API for data queries and workflow management. +- `aiida-diff `_: AiiDA demo plugin that computes the difference between two + files. + +The full list of available plugins can be found on the `AiiDA plugin registry `_. diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 8553b84363..76b0b41ece 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -9,4 +9,5 @@ Reference api/index rest_api cheatsheet + core_plugins _changelog.md