Skip to main content

AiiDA plugin providing support for Plumed2

Project description

Build Status Coverage Status Docs status PyPI version

aiida-plumed

AiiDA plugin providing support for Plumed2

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('plumed')
    inputs['parameters'] = DiffParameters(dict=d)
    
  • DiffParameters dictionaries are validated using voluptuous. Find out about supported options:

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

Installation

pip install aiida-plumed
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 plumed list
verdi data plumed export <PK>

Development

git clone https://github.com/ConradJohnston/aiida-plumed .
cd aiida-plumed
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

Contact

conrad.s.johnston@googlemail.com

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-plumed-0.1.0a0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

aiida_plumed-0.1.0a0-py2-none-any.whl (23.0 kB view details)

Uploaded Python 2

File details

Details for the file aiida-plumed-0.1.0a0.tar.gz.

File metadata

  • Download URL: aiida-plumed-0.1.0a0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/2.7.10

File hashes

Hashes for aiida-plumed-0.1.0a0.tar.gz
Algorithm Hash digest
SHA256 91ed80b585d4fe1707edb515d05df757b161b1f8b387db2d0294460f3ef946f0
MD5 c5d7b4373173b66533de5c8c02f5cbd2
BLAKE2b-256 219361957a59ff9c552bff83acc8eb4c488dbf51c345f80876716a3cfaccc12c

See more details on using hashes here.

File details

Details for the file aiida_plumed-0.1.0a0-py2-none-any.whl.

File metadata

  • Download URL: aiida_plumed-0.1.0a0-py2-none-any.whl
  • Upload date:
  • Size: 23.0 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/2.7.10

File hashes

Hashes for aiida_plumed-0.1.0a0-py2-none-any.whl
Algorithm Hash digest
SHA256 755c31e8cb977179676605f6584cda14b95bde1893f3a0cf2094dbe88eb85b8f
MD5 9895ffc7b02f06320ec46915b5365e49
BLAKE2b-256 1abf4c5fbd50727f3930d6f6c22d434b1d0f749b05a61418c6cedb90a5465407

See more details on using hashes here.

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