Metadata-Version: 2.0
Name: aiida-zeopp
Version: 0.2.0
Summary: AiiDA plugin for zeo++
Home-page: https://github.com/ltalirz/aiida-zeopp
Author: Leopold Talirz
Author-email: leopold.talirz@epfl.ch
License: Creative Commons
Platform: UNKNOWN
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
Provides-Extra: pre-commit
Provides-Extra: testing
Requires-Dist: aiida (>=0.12.2)
Requires-Dist: pycifrw (>=4.2)
Requires-Dist: pymatgen (>=2016.1.0)
Requires-Dist: six
Requires-Dist: voluptuous
Provides-Extra: pre-commit
Requires-Dist: pre-commit (==1.11.0); extra == 'pre-commit'
Requires-Dist: prospector (==1.1.5); extra == 'pre-commit'
Requires-Dist: pylint (==1.9.3); extra == 'pre-commit'
Requires-Dist: yapf (==0.24.0); extra == 'pre-commit'
Provides-Extra: testing
Requires-Dist: coverage; extra == 'testing'
Requires-Dist: mock (==2.0.0); extra == 'testing'
Requires-Dist: pgtest (==1.1.0); extra == 'testing'
Requires-Dist: sqlalchemy-diff (==0.1.3); extra == 'testing'
Requires-Dist: wheel (>=0.31); extra == 'testing'

[![Build Status](https://travis-ci.org/ltalirz/aiida-zeopp.svg?branch=master)](https://travis-ci.org/ltalirz/aiida-zeopp)
[![Coverage Status](https://coveralls.io/repos/github/ltalirz/aiida-zeopp/badge.svg?branch=master)](https://coveralls.io/github/ltalirz/aiida-zeopp?branch=master)
[![Docs status](https://readthedocs.org/projects/aiida-zeopp/badge)](http://aiida-zeopp.readthedocs.io/)
[![PyPI version](https://badge.fury.io/py/aiida-zeopp.svg)](https://badge.fury.io/py/aiida-zeopp)

# aiida-zeopp

AiiDA plugin for [Zeo++](http://www.zeoplusplus.org/)

## Installation

```shell
git clone https://github.com/ltalirz/aiida-zeopp aiida-zeopp
cd aiida-zeopp
pip install -e .  # also installs aiida, if missing (but not postgres)
reentry scan
verdi quicksetup  # better to set up a new profile
verdi calculation plugins  # should now show your calclulation plugins
```

## Usage

```shell
verdi daemon start         # make sure the daemon is running
cd examples
verdi run submit.py        # submit test calculation
verdi calculation list -a  # check status of calculation
```

See `examples/submit.py` for an example of how to set up a calculation:

 * Use `CifData` to specify input structure.
 * (optional) Use `SinglefileData` to specify atomic radii file.
 * Use `NetworkParameters` dictionary to specify other command line options.
   For a complete list of supported command line options, see [here](aiida_zeopp/data/parameters.py)

## Tests

The following will discover and run all unit test:
```shell
pip install -e .[testing]
python manage.py
```

## Analyzing output

```shell
$ verdi calculation show 88
-----------  ------------------------------------------------------------------------------
type         NetworkCalculation
pk           88
uuid         deb63433-4dcd-4ca1-9165-cb97877496b3
label        aiida_zeopp example calculation
description  Converts .cif to .cssr format, computes surface area, pore volume and channels
ctime        2018-11-19 09:12:55.259776+00:00
mtime        2018-11-19 09:15:15.708275+00:00
computer     [1] localhost
code         network
-----------  ------------------------------------------------------------------------------
##### INPUTS:
Link label      PK  Type
------------  ----  -----------------
parameters      87  NetworkParameters
structure       86  CifData
##### OUTPUTS:
Link label           PK  Type
-----------------  ----  --------------
remote_folder        89  RemoteData
retrieved            90  FolderData
structure_cssr       91  SinglefileData
output_parameters    92  ParameterData

$ verdi calculation res 88
{
  "ASA_A^2": 3532.09,
  "ASA_m^2/cm^3": 1932.13,
  "ASA_m^2/g": 2197.86,
  "Channel_surface_area_A^2": 3532.09,
  "Channels": {
    "Dimensionalities": [
      3
    ],
    "Largest_free_spheres": [
      6.74621
    ],
    "Largest_included_free_spheres": [
      13.1994
    ],
    "Largest_included_spheres": [
      13.1994
    ]
  },
  "Density": 0.879097,
  "Input_chan": 1.2,
  "Input_cssr": true,
  "Input_sa": [
    1.82,
    1.82,
    1000
  ],
  "Input_structure_filename": "HKUST-1.cif",
  "Input_volpo": [
    1.82,
    1.82,
    1000
  ],
  "NASA_A^2": 0.0,
  "NASA_m^2/cm^3": 0.0,
  "NASA_m^2/g": 0.0,
  "Number_of_channels": 1,
  "Number_of_pockets": 0,
  "POAV_A^3": 9049.01,
  "POAV_Volume_fraction": 0.495,
  "POAV_cm^3/g": 0.563078,
  "PONAV_A^3": 0.0,
  "PONAV_Volume_fraction": 0.0,
  "PONAV_cm^3/g": 0.0,
  "Pocket_surface_area_A^2": 0.0,
  "Unitcell_volume": 18280.8
}

$ verdi calculation outputls 88
_scheduler-stderr.txt
_scheduler-stdout.txt
out.chan
out.cssr
out.sa
out.volpo

$ verdi calculation outputcat 88 -p out.sa
@ out.sa Unitcell_volume: 18280.8   Density: 0.879097   ASA_A^2: 3532.09 ASA_m^2/cm^3: 1932.13 ASA_m^2/g: 2197.86 NASA_A^2: 0 NASA_m^2/cm^3: 0 NASA_m^2/g: 0
Number_of_channels: 1 Channel_surface_area_A^2: 3532.09
Number_of_pockets: 0 Pocket_surface_area_A^2:
```

## License

MIT

## Contact
leopold.talirz@gmail.com


