Metadata-Version: 2.4
Name: aiidalab
Version: 26.5.0
Summary: Implements core functions of AiiDAlab
Author-email: The AiiDAlab team <aiidalab@materialcloud.org>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AiiDA
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
License-File: LICENSE
Requires-Dist: cachetools~=4.1
Requires-Dist: click>=7.0,<9
Requires-Dist: click-spinner~=0.1
Requires-Dist: dulwich~=0.20
Requires-Dist: packaging>=20.1
Requires-Dist: pip
Requires-Dist: requests~=2.27
Requires-Dist: requests-cache~=1.0
Requires-Dist: setuptools<82.0
Requires-Dist: tabulate~=0.8
Requires-Dist: toml~=0.10
Requires-Dist: traitlets~=5.0
Requires-Dist: watchdog~=6.0
Requires-Dist: bumpver>=2021.1114 ; extra == "dev"
Requires-Dist: pre-commit>=3.4 ; extra == "dev"
Requires-Dist: pytest~=8.4.0 ; extra == "dev"
Requires-Dist: pytest-cov~=7.0 ; extra == "dev"
Requires-Dist: ruamel.yaml~=0.16 ; extra == "dev"
Requires-Dist: mypy~=1.19.0 ; extra == "dev"
Requires-Dist: types-tabulate~=0.8 ; extra == "dev"
Requires-Dist: types-jsonschema~=3.2 ; extra == "dev"
Requires-Dist: types-cachetools~=4.1 ; extra == "dev"
Requires-Dist: types-requests~=2.27 ; extra == "dev"
Requires-Dist: types-toml~=0.10 ; extra == "dev"
Requires-Dist: types-click-spinner~=0.1 ; extra == "dev"
Requires-Dist: pydata-sphinx-theme~=0.13.3 ; extra == "docs"
Requires-Dist: sphinx~=4.5.0 ; extra == "docs"
Requires-Dist: sphinx-design~=0.4.0 ; extra == "docs"
Requires-Dist: sphinxcontrib-contentui ; extra == "docs"
Requires-Dist: sphinxcontrib-details-directive ; extra == "docs" and ( python_version >= '3.0')
Requires-Dist: sphinxcontrib-applehelp==1.0.4 ; extra == "docs"
Requires-Dist: sphinxcontrib-devhelp==1.0.2 ; extra == "docs"
Requires-Dist: sphinxcontrib-htmlhelp==2.0.1 ; extra == "docs"
Requires-Dist: sphinxcontrib-qthelp==1.0.3 ; extra == "docs"
Requires-Dist: sphinxcontrib-serializinghtml==1.1.5 ; extra == "docs"
Requires-Dist: CacheControl~=0.12 ; extra == "registry"
Requires-Dist: jsonref~=0.2 ; extra == "registry"
Requires-Dist: jsonschema[format]~=3.2 ; extra == "registry"
Requires-Dist: Jinja2~=3.0 ; extra == "registry"
Requires-Dist: requests-mock~=1.8 ; extra == "registry"
Requires-Dist: ruamel.yaml~=0.16 ; extra == "registry"
Project-URL: Documentation, https://aiidalab.readthedocs.io/en/latest/
Project-URL: Home, https://www.aiidalab.net/
Project-URL: Source, https://github.com/aiidalab/aiidalab
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: registry

[![Documentation Status](https://readthedocs.org/projects/aiidalab/badge/)](https://aiidalab.readthedocs.io/)
[![codecov](https://codecov.io/gh/aiidalab/aiidalab/branch/main/graph/badge.svg)](https://codecov.io/gh/aiidalab/aiidalab)
# AiiDAlab package

The `aiidalab` package manages [AiiDAlab](https://www.aiidalab.net) applications within the [AiiDAlab Docker stack](https://github.com/aiidalab/aiidalab-docker-stack). It contains API and CLI interface to install/uninstall apps from the [AiiDAlab App registry](https://aiidalab.github.io/aiidalab-registry/) or directly from Git repositories. It also contains the code for building the App Registry, although the actual registry data are housed and deployed in a [aiidalab-registry repository](https://github.com/aiidalab/aiidalab-registry).

## Installation

Install latest version from pypi:
```
pip install aiidalab
```

or from the `conda-forge` conda channel:
```console
conda install -c conda-forge aiidalab
```

## Documentation
The documentation can be found on the [following web page](https://aiidalab.readthedocs.io).

## For maintainers

To create a new release, clone the repository, install development dependencies with `pip install -e '.[dev]'`, and then execute `bumpver update`.
This will:

  1. Create a tagged release with bumped version and push it to the repository.
  2. Trigger a GitHub actions workflow that creates a GitHub release.

Additional notes:

  - Use the `--dry` option to preview the release change.
  - The release tag (e.g. a/b/rc) is determined from the last release.
    Use the `--tag` option to switch the release tag.

## License

MIT

## Citation

Users of AiiDAlab are kindly asked to cite the following publication in their own work:

A. V. Yakutovich et al., Comp. Mat. Sci. 188, 110165 (2021).
[DOI:10.1016/j.commatsci.2020.110165](https://doi.org/10.1016/j.commatsci.2020.110165)

## Contact

aiidalab@materialscloud.org

## Acknowledgements

This work is supported by the [MARVEL National Centre for Competency in Research](<https://nccr-marvel.ch>)
funded by the [Swiss National Science Foundation](<https://www.snf.ch/en>), as well as by the [MaX
European Centre of Excellence](https://www.max-centre.eu/) funded by the Horizon 2020 EINFRA-5 program,
Grant No. 676598.

![MARVEL](miscellaneous/logos/MARVEL.png)
![MaX](miscellaneous/logos/MaX.png)

