Skip to content

Commit

Permalink
First test version (#1)
Browse files Browse the repository at this point in the history
* add test yaml file
  • Loading branch information
superstar54 committed Mar 25, 2024
1 parent 14b87fa commit 505816c
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 2 deletions.
20 changes: 20 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Install pre-commit hooks via
# pre-commit install

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: end-of-file-fixer
- id: fix-encoding-pragma
- id: mixed-line-ending
- id: trailing-whitespace
- id: check-json

- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.3.3
hooks:
- id: ruff
args: [--fix, --exit-non-zero-on-fix, --show-fixes]
- id: ruff-format
38 changes: 36 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# aiidalab-qe-plugin-registry
Registry plugins for AiiDAlab-Quantum ESPRESSO App
## AiiDAlab Quantum ESPRESSO Plugin Registry

This repository serves as the central registry for AiiDAlab-Quantum ESPRESSO App plugins. It's designed for developers who are either in the process of creating a new plugin or already have one developed. If you fit into one of these categories, you're encouraged to register your plugin here to become part of the official AiiDAlab plugin ecosystem.

### Registering Your Plugin

To include your plugin in the registry, follow these steps:

1. **Fork this repository.**
2. **Add your plugin to the `plugins.yaml` file.** Place your entry at the end of the file, following this example:
```yaml
...
aiidalab-qe-xyz:
description: "Quantum ESPRESSO plugin for XYZ by AiiDAlab."
author: "Alice Doe"
github: "https://github.com/alicedoe/aiidalab-qe-xyz"
documentation: "https://aiidalab-qe-xyz.readthedocs.io/"
pip: "aiidalab-qe-xyz"
```
3. **Submit a Pull Request.** Direct it to [this repository's Pull Requests section](https://github.com/aiidalab/aiidalab-qe-plugin-registry/pulls).

### 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, `aiida-coolfeature` or `aiidalab-qe-neutron`.
- **description:** A brief description of your plugin.

#### Optional Keys

- **gitHub:** If provided, this should be the URL to the plugin's GitHub homepage. At least one of `github` or `pip` is required.
- **pip:** The PyPI package name for your plugin, useful for installation via pip. Example: `aiida-quantum`.
- **documentation:** The URL to your plugin's online documentation, such as ReadTheDocs.
- **author:** The developer of the plugin.

By following these guidelines, you can ensure your plugin is correctly listed and accessible within the AiiDAlab Quantum ESPRESSO plugin registry, facilitating its discovery and use by the community.
16 changes: 16 additions & 0 deletions plugins.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
aiida-bader:
description: AiiDA plugin for the Bader analysis
author: Xing Wang
github: https://github.com/superstar54/aiida-bader
documentation: https://aiida-bader.readthedocs.io/
pip: aiida-bader

aiidalab-qe-vibroscopy:
description: Plugin to compute vibrational properties of materials via the aiida-vibroscopy AiiDA plugin
author: Miki Bonacci
github: https://github.com/mikibonacci/aiidalab-qe-vibroscopy

aiidalab-qe-muon:
description: Plugin to compute muon stopping sites and related properties via the aiida-muon and aiida-musconv AiiDA plugins
author: Miki Bonacci
github: https://github.com/mikibonacci/aiidalab-qe-muon

0 comments on commit 505816c

Please sign in to comment.