Metadata-Version: 2.1
Name: aiida-diff
Version: 1.0.0a1
Summary: AiiDA demo plugin that computes the difference between two files.
Home-page: https://github.com/aiidateam/aiida-diff
Author: The AiiDA developers group
Author-email: 
License: MIT
Description: [![Build Status](https://travis-ci.org/aiidateam/aiida-diff.svg?branch=master)](https://travis-ci.org/aiidateam/aiida-diff) 
        [![Coverage Status](https://coveralls.io/repos/github/aiidateam/aiida-diff/badge.svg?branch=master)](https://coveralls.io/github/aiidateam/aiida-diff?branch=master) 
        [![Docs status](https://readthedocs.org/projects/aiida-diff/badge)](http://aiida-diff.readthedocs.io/) 
        [![PyPI version](https://badge.fury.io/py/aiida-diff.svg)](https://badge.fury.io/py/aiida-diff)
        
        # aiida-diff
        
        AiiDA demo plugin that computes the difference between two files.
        
        This plugin is the default output of the 
        [AiiDA plugin cutter](https://github.com/aiidateam/aiida-plugin-cutter),
        intended to help developers get started with their AiiDA plugins.
        
        ## Features
        
         * Add input files using `SinglefileData`:
           ```python
           SinglefileData = DataFactory('singlefile')
           inputs['file1'] = SinglefileData(file='/path/to/file1')
           inputs['file2'] = SinglefileData(file='/path/to/file2')
           ```
        
         * Specify command line options via a python dictionary and `DiffParameters`:
           ```python
           d = { 'ignore-case': True }
           DiffParameters = DataFactory('diff')
           inputs['parameters'] = DiffParameters(dict=d)
           ```
        
         * `DiffParameters` dictionaries are validated using [voluptuous](https://github.com/alecthomas/voluptuous).
           Find out about supported options:
           ```python
           DiffParameters = DataFactory('diff')
           print(DiffParameters.schema.schema)
           ```
        
        ## Installation
        
        ```shell
        pip install aiida-diff
        verdi quicksetup  # better to set up a new profile
        verdi plugin list aiida.calculations  # should now show your calclulation plugins
        ```
        
        ## Usage
        
        Here goes a complete example of how to submit a test calculation using this plugin.
        
        A quick demo of how to submit a calculation:
        ```shell
        verdi daemon start         # make sure the daemon is running
        cd examples
        verdi run submit.py        # submit test calculation
        verdi process list -a  # check status of calculation
        ```
        
        The plugin also includes verdi commands to inspect its data types:
        ```shell
        verdi data diff list
        verdi data diff export <PK>
        ```
        
        ## Development
        
        ```shell
        git clone https://github.com/aiidateam/aiida-diff .
        cd aiida-diff
        pip install -e .[pre-commit,testing]  # install extra dependencies
        pre-commit install  # install pre-commit hooks
        pytest -v  # discover and run all tests
        ```
        
        See the [developer guide](http://aiida-diff.readthedocs.io/en/latest/developer_guide/index.html) for more information.
        
        ## License
        
        MIT
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Framework :: AiiDA
Description-Content-Type: text/markdown
Provides-Extra: pre-commit
Provides-Extra: testing
Provides-Extra: docs
