Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Dec 5, 2023
1 parent f884891 commit 1d571ae
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/source/development/plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -354,19 +354,19 @@ Here is the example of the built-in `pdos` plugins with codes `dos.x` and `projw
}
For the moment, the app does not support set up the newly added codes automatically.
Thus, the user needs to set up the codes manually. However, the developer can provide console
scripts to make user life easier. Please read to following section for some instructions on how
Thus, the user needs to set up the codes manually. However, the developer can provide console
scripts to make user life easier. Please read to following section for some instructions on how
to do it.


Setting up console scripts for automatic code installation
----------------------------------------------------------
It is possible to provide console scripts in order to make new code installation almost automatic,
with only running an instruction from the command line.
It is possible to provide console scripts in order to make new code installation almost automatic,
with only running an instruction from the command line.
Console scripts can be defined in the `pyproject.toml`:

.. code-block::
[project.scripts]
phonopy_install = "phonopy_install:install_phonopy"
Expand All @@ -376,7 +376,7 @@ When the user, after the package installation, will execute the command
phonopy_install
this will invoke the function `install_phonopy`, contained in the phonopy_install.py file in the
this will invoke the function `install_phonopy`, contained in the phonopy_install.py file in the
root directory of the package.

or in the `setup.cfg` file (if you prefer):
Expand All @@ -387,7 +387,7 @@ or in the `setup.cfg` file (if you prefer):
console_scripts=
install_muon_codes = aiidalab_qe_muon.scripts.post_install:InstallCodes
this will invoke the function `InstallCodes`, contained in the post_install.py file in the
this will invoke the function `InstallCodes`, contained in the post_install.py file in the
{root-directory-of-the-package}/aiidalab_qe_muon/scripts/ directory.

These examples are taken respectively from `aiidalab-qe-vibroscopy`_ and `aiidalab-qe-muon`_.
Expand Down Expand Up @@ -439,4 +439,4 @@ You can also use them as a start point to create your own plugins.

.. _aiidalab-qe-plugin-demos: https://github.com/aiidalab/aiidalab-qe-plugin-demos
.. _aiidalab-qe-vibroscopy: https://github.com/mikibonacci/aiidalab-qe-vibroscopy
.. _aiidalab-qe-muon: https://github.com/mikibonacci/aiidalab-qe-muon
.. _aiidalab-qe-muon: https://github.com/mikibonacci/aiidalab-qe-muon

0 comments on commit 1d571ae

Please sign in to comment.