diff --git a/docs/source/development/plugin_registry.rst b/docs/source/development/plugin_registry.rst index ef2f6f616..a7855ff03 100644 --- a/docs/source/development/plugin_registry.rst +++ b/docs/source/development/plugin_registry.rst @@ -16,7 +16,8 @@ To include your plugin in the registry, follow these steps: .. code-block:: yaml - aiidalab-qe-xyz: + Top-level key: + title: "Description to show on top" description: "Quantum ESPRESSO plugin for XYZ by AiiDAlab." author: "Alice Doe" github: "https://github.com/alicedoe/aiidalab-qe-xyz" @@ -31,8 +32,9 @@ Plugin Entry Requirements **Required Keys** -- **Top-level key:** The plugin's distribution name, which should be lowercase and prefixed by ``aiidalab-`` or ``aiida-``. For example, ``aiidalab-qe-coolfeature`` or ``aiidalab-neutron``. -- **description:** A brief description of your plugin. +- **Top-level key:** The plugin's distribution name, which should be lowercase and prefixed by ``aiidalab-`` or ``aiida-``. For example, ``aiidalab-qe-coolfeature`` or ``aiidalab-neutron``. +- **title:** Brief title to show on top of the plugin entry. Should contain the main properties we can compute with the given plugin. +- **description:** A brief description of your plugin. Can include more verbose informations with respect to the title. **Optional Keys** diff --git a/plugin_list.ipynb b/plugin_list.ipynb index ea5830c29..05a5c8108 100644 --- a/plugin_list.ipynb +++ b/plugin_list.ipynb @@ -282,31 +282,17 @@ " ]\n", " )\n", "\n", - " title_with_icon = f\"{plugin_name} {'✅' if installed else '☐'}\"\n", + " title_with_icon = f\"{plugin_data.get('title')} {'✅' if installed else '☐'}\"\n", " accordion.set_title(i, title_with_icon)\n", " accordion.children = [*accordion.children, box]\n", "\n", "display(accordion)" ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [] } ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "base", "language": "python", "name": "python3" }, diff --git a/plugins.yaml b/plugins.yaml index 65fd3fcbc..2b21306a0 100644 --- a/plugins.yaml +++ b/plugins.yaml @@ -1,18 +1,21 @@ --- -Bader charge analysis (aiida-bader): +aiida-bader: + title: Bader charge analysis (aiida-bader) description: Perform Bader charge analysis of the electronic charge density author: Xing Wang github: https://github.com/superstar54/aiida-bader documentation: https://aiida-bader.readthedocs.io/ pip: aiida-bader -Phonons and IR/Raman (aiidalab-qe-vibroscopy): - description: Plugin to compute phonons, IR/Raman spectra, Inelastic Neutron Scattering of materials +aiidalab-qe-vibroscopy: + title: Phonons and IR/Raman (aiidalab-qe-vibroscopy) + description: Plugin to compute phonons, IR/Raman spectra, Inelastic Neutron Scattering of materials via finite displacement and finite field approach. author: Miki Bonacci, Andres Ortega Guerrero, Lorenzo Bastonero and Nicola Marzari pip: aiidalab-qe-vibroscopy==1.1.1 post_install: setup-phonopy -Muon spectroscopy (aiidalab-qe-muon): - description: Compute properties to assist µSR experiments, such as muon stopping sites and related properties +aiidalab-qe-muon: + title: Muon spectroscopy (aiidalab-qe-muon) + description: Compute properties to assist µSR experiments, such as muon stopping sites and related properties (local fields and polarization signals). author: Miki Bonacci, Ifeanyi J. Onuorah, Pietro Bonfa', Giovanni Pizzi and Roberto de Renzi github: https://github.com/mikibonacci/aiidalab-qe-muon