Skip to main content

AiiDA demo plugin that wraps the `diff` executable for computing the difference between two files.

Project description

Build Status Coverage Status Docs status PyPI version

aiida-diff

AiiDA demo plugin that wraps the diff executable for computing the difference between two files.

This plugin is the default output of the AiiDA plugin cutter, intended to help developers get started with their AiiDA plugins.

Features

  • Add input files using SinglefileData:

    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:

    d = { 'ignore-case': True }
    DiffParameters = DataFactory('diff')
    inputs['parameters'] = DiffParameters(dict=d)
    
  • DiffParameters dictionaries are validated using voluptuous. Find out about supported options:

    DiffParameters = DataFactory('diff')
    print(DiffParameters.schema.schema)
    

Installation

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:

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:

verdi data diff list
verdi data diff export <PK>

Development

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 for more information.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiida-diff-1.0.0b1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

aiida_diff-1.0.0b1-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file aiida-diff-1.0.0b1.tar.gz.

File metadata

  • Download URL: aiida-diff-1.0.0b1.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for aiida-diff-1.0.0b1.tar.gz
Algorithm Hash digest
SHA256 cb6a8487bce282269fe4bb215cbb16f3ee14b08bfdfc8a5696480ea03c718aa1
MD5 948e8be259044f371a8790b65b4013f1
BLAKE2b-256 57ac7753b22279fb5ce2e871e15300d01bab77e86f21640f99cdecf6d6d4e841

See more details on using hashes here.

Provenance

File details

Details for the file aiida_diff-1.0.0b1-py2.py3-none-any.whl.

File metadata

  • Download URL: aiida_diff-1.0.0b1-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for aiida_diff-1.0.0b1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d8d10dd4fb691c3630c210583c35a0d05ebb147fee0f5a553968277131ce962b
MD5 9aea4905ff61c97457cf362665b9aebb
BLAKE2b-256 1cb366da8a081ad5d8733d7cab82be93e59f0c50978feb64001fbf55612325a3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page