Metadata-Version: 2.1
Name: aiidalab-widgets-base
Version: 0.3.0b1
Summary: Reusable widgets for applications in the AiiDA Lab.
Home-page: https://github.com/aiidalab/aiidalab-widgets-base
Author: AiiDA Team
Author-email: aiidateam@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
Requires-Dist: aiida-core[jupyter] (>=0.11)
Requires-Dist: ase
Requires-Dist: numpy
Requires-Dist: ipywidgets
Requires-Dist: fileupload
Requires-Dist: nglview
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Provides-Extra: pre-commit
Requires-Dist: pre-commit ; extra == 'pre-commit'
Requires-Dist: yapf ; extra == 'pre-commit'
Requires-Dist: prospector ; extra == 'pre-commit'
Requires-Dist: pylint ; extra == 'pre-commit'
Provides-Extra: testing
Requires-Dist: aiida-core[testing] ; extra == 'testing'

# aiidalab-widgets-base 

Reusable widgets for applications in the AiiDA Lab.

## Installation

Install the `aiidalab_widgets_base` python package via:
```
pip install aiidalab-widgets-base 
```

Install the corresponding `aiidalab-widgets-base` AiiDA Lab application
via the app manager as usual.

## Usage

Using the widgets usually just involves importing and displaying them.
For demos, have a look at the jupyter notebooks (`.ipynb` extension) in
this folder.

### Structures

Uploading structures
```python
from aiidalab_widgets_base import StructureUploadWidget
from IPython.display import display

widget = StructureUploadWidget()
# Enforce node format to be CifData:
# widget = StructureUploadWidget(node_class='CifData')
display(widget)
```

![Demo](https://image.ibb.co/fjnHco/structure.gif "Using the StructureUploadWidget.")

### Codes

Selecting codes
```python
from aiidalab_widgets_base import CodeDropdown
from IPython.display import display

# Select from installed codes for 'zeopp.network' input plugin
dropdown = CodeDropdown(input_plugin='zeopp.network')
display(dropdown)

dropdown.selected_code  # returns selected code
```

![Demo](https://image.ibb.co/gSFFf8/codes.gif "Using the CodeDropDown.")

## License

MIT

## Contact

aiidalab@materialscloud.org

## Acknowledgements

This work is supported by the [MARVEL National Centre for Competency in Research](<http://nccr-marvel.ch>)
funded by the [Swiss National Science Foundation](<http://www.snf.ch/en>), as well as by the [MaX
European Centre of Excellence](<http://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)


