https://github.com/aiidateam/aiida-diff
AiiDA demo plugin that computes the difference between two files.
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.5%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
AiiDA demo plugin that computes the difference between two files.
Basic Info
- Host: GitHub
- Owner: aiidateam
- License: mit
- Language: Python
- Default Branch: master
- Homepage: https://aiida-diff.readthedocs.io
- Size: 183 KB
Statistics
- Stars: 2
- Watchers: 3
- Forks: 10
- Open Issues: 1
- Releases: 1
Topics
Metadata Files
README.md
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.
Repository contents
.github/: Github Actions configurationci.yml: runs tests, checks test coverage and builds documentation at every new commitpublish-on-pypi.yml: automatically deploy git tags to PyPI - just generate a PyPI API token for your PyPI account and add it to thepypi_tokensecret of your github repository
aiida_diff/: The main source code of the plugin packagedata/: A newDiffParametersdata class, used as input to theDiffCalculationCalcJobclasscalculations.py: A newDiffCalculationCalcJobclasscli.py: Extensions of theverdi datacommand line interface for theDiffParametersclasshelpers.py: Helpers for setting up an AiiDA code fordiffautomaticallyparsers.py: A newParserfor theDiffCalculation
docs/: A documentation template ready for publication on Read the Docsexamples/: An example of how to submit a calculation using this plugintests/: Basic regression tests using the pytest framework (submitting a calculation, ...). Installpip install -e .[testing]and runpytest..gitignore: Telling git which files to ignore.pre-commit-config.yaml: Configuration of pre-commit hooks that sanitize coding style and check for syntax errors. Enable viapip install -e .[pre-commit] && pre-commit install.readthedocs.yml: Configuration of documentation build for Read the DocsLICENSE: License for your pluginREADME.md: This fileconftest.py: Configuration of fixtures for pytestpyproject.toml: Python package metadata for registration on PyPI and the AiiDA plugin registry (including entry points)
See also the following video sequences from the 2019-05 AiiDA tutorial:
- run aiida-diff example calculation
- aiida-diff CalcJob plugin
- aiida-diff Parser plugin
- aiida-diff computer/code helpers
- aiida-diff input data (with validation)
- aiida-diff cli
- aiida-diff tests
- Adding your plugin to the registry
- pre-commit hooks
For more information, see the developer guide of your plugin.
Features
Add input files using
SinglefileData:python SinglefileData = DataFactory('core.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)DiffParametersdictionaries are validated using 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
./example_01.py # run test calculation
verdi process list -a # check record 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 --upgrade pip
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
Owner
- Name: AiiDA team
- Login: aiidateam
- Kind: organization
- Website: http://www.aiida.net
- Repositories: 63
- Profile: https://github.com/aiidateam
The development team of AiiDA
GitHub Events
Total
Last Year
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Leopold Talirz | l****z@g****m | 42 |
| Chris Sewell | c****l@h****m | 3 |
| Sebastiaan Huber | m****l@s****t | 1 |
| Katrin Leinweber | 9****r | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 4
- Total pull requests: 39
- Average time to close issues: about 1 month
- Average time to close pull requests: 2 days
- Total issue authors: 3
- Total pull request authors: 5
- Average comments per issue: 0.5
- Average comments per pull request: 1.15
- Merged pull requests: 35
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- ltalirz (2)
- greschd (1)
- AmberLEE123456 (1)
Pull Request Authors
- ltalirz (35)
- chrisjsewell (3)
- sphuber (1)
- katrinleinweber (1)
- agoscinski (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 71 last-month
- Total dependent packages: 1
- Total dependent repositories: 1
- Total versions: 6
- Total maintainers: 3
pypi.org: aiida-diff
AiiDA demo plugin that wraps the `diff` executable for computing the difference between two files.
- Documentation: https://aiida-diff.readthedocs.io/
- License: MIT License
-
Latest release: 2.0.0
published about 4 years ago
Rankings
Maintainers (3)
Dependencies
- actions/checkout v2 composite
- actions/setup-python v2 composite
- postgres 10 docker
- rabbitmq latest docker
- actions/checkout v2 composite
- actions/setup-python v1 composite
- aiida-core >=2.5,<3
- voluptuous *