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 overview of common core plugins to RTD #6644

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,23 @@

To the architecture guide

.. grid-item-card:: :fa:`puzzle-piece;mr-1` Core plugins
:text-align: center
:shadow: md

Commonly used AiiDA plugins to extend core functionality

+++++++++++++++++++++++++++++++++++++++++++++

.. button-ref:: reference/core_plugins
:ref-type: doc
:click-parent:
:expand:
:color: primary
:outline:

To the plugin overview

------------------------------

.. admonition:: Need support?
Expand Down
132 changes: 132 additions & 0 deletions docs/source/reference/core_plugins.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
.. _reference:core_plugins:

============================
Common plugins to AiiDA core
============================

.. aiida-shell
.. aiida-workgraph

.. aiida-submission-controller
.. aiida-hyperqueue

.. aiida-project
.. aiida-plugin-cutter

.. aiida-code-registry
.. aiida-pythonjob

.. grid:: 1 2 2 4
:gutter: 3

.. grid-item-card:: :fa:`icon;mr-1` Title 1
:text-align: center
:shadow: md

AiiDA shell

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link:: https://github.com/sphuber/aiida-shell
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 2
:text-align: center
:shadow: md

AiiDA WorkGraph

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link:: https://github.com/aiidateam/aiida-workgraph
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 3
:text-align: center
:shadow: md

AiiDA submission controller

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link:: https://github.com/aiidateam/aiida-submission-controller/
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 4
:text-align: center
:shadow: md

AiiDA hyperqueue

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link:: https://github.com/aiidateam/aiida-hyperqueue
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 5
:text-align: center
:shadow: md

AiiDA project

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link:: https://github.com/aiidateam/aiida-project
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 6
:text-align: center
:shadow: md

AiiDA plugin cookiecutter

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link::https://github.com/aiidateam/aiida-plugin-cutter
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 7
:text-align: center
:shadow: md

AiiDA code registry

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link::https://github.com/aiidateam/aiida-code-registry
:color: primary
:outline:

Go to GitHub

.. grid-item-card:: :fa:`icon;mr-1` Title 8
:text-align: center
:shadow: md

AiiDA PythonJob

+++++++++++++++++++++++++++++++++++++++++++++

.. button-link::https://github.com/aiidateam/aiida-pythonjob
:color: primary
:outline:

Go to GitHub
1 change: 1 addition & 0 deletions docs/source/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ Reference
api/index
rest_api
cheatsheet
core_plugins
_changelog.md
Loading