aiida-ssh2win

aiida-ssh2win

A transport plugin allowing AiiDA to run calculations on Windows machines.

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 configuration
  • ci.yml: runs tests, checks test coverage and builds documentation at every new commit
  • publish-on-pypi.yml: automatically deploy git tags to PyPI - just generate a PyPI API token for your PyPI account and add it to the pypi_token secret of your github repository
• aiida_ssh2win/: The main source code of the plugin package
  • transport.py: Contains SshToWindowsTransport - a concrete implementation of AiiDA's Transport interface
• docs/: A documentation template ready for publication on Read the Docs
• tests/: Unit testing using the pytest framework. Install pip install -e .[testing] and run pytest.
• .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 via pip install -e .[pre-commit] && pre-commit install
• .readthedocs.yml: Configuration of documentation build for Read the Docs
• LICENSE: License for your plugin
• README.md: This file
• conftest.py: Configuration of fixtures for pytest
• pyproject.toml: Python package metadata for registration on PyPI and the AiiDA plugin registry (including entry points)

Installation

pip install aiida-ssh2win
verdi quicksetup  # better to set up a new profile
verdi plugin list aiida.transports  # should now show the `ssh2win` plugins

Usage

License

MIT

Contact

edan.bainglass@gmail.com