{"id":30619146,"url":"https://github.com/aiidaplugins/aiida-skeaf","last_synced_at":"2026-01-20T17:01:26.600Z","repository":{"id":79905130,"uuid":"464511183","full_name":"aiidaplugins/aiida-skeaf","owner":"aiidaplugins","description":"AiiDA plugin for the Supercell K-space Extremal Area Finder (SKEAF) code","archived":false,"fork":false,"pushed_at":"2025-08-21T19:06:43.000Z","size":5456,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-22T00:56:37.768Z","etag":null,"topics":["aiida","skeaf"],"latest_commit_sha":null,"homepage":"https://aiida-skeaf.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aiidaplugins.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-02-28T14:18:22.000Z","updated_at":"2025-08-21T19:04:34.000Z","dependencies_parsed_at":"2025-08-21T20:41:20.105Z","dependency_job_id":"51fb3495-af25-4cd2-9ebf-89865513f998","html_url":"https://github.com/aiidaplugins/aiida-skeaf","commit_stats":null,"previous_names":["aiidaplugins/aiida-skeaf"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/aiidaplugins/aiida-skeaf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidaplugins%2Faiida-skeaf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidaplugins%2Faiida-skeaf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidaplugins%2Faiida-skeaf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidaplugins%2Faiida-skeaf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aiidaplugins","download_url":"https://codeload.github.com/aiidaplugins/aiida-skeaf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aiidaplugins%2Faiida-skeaf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aiida","skeaf"],"created_at":"2025-08-30T12:18:51.844Z","updated_at":"2026-01-20T17:01:26.559Z","avatar_url":"https://github.com/aiidaplugins.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status][ci-badge]][ci-link]\n[![Coverage Status][cov-badge]][cov-link]\n[![Docs status][docs-badge]][docs-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\n# aiida-skeaf\n\nAiiDA plugin for the Supercell K-space Extremal Area Finder (SKEAF) code.\n\n## Installation\n\n```shell\npip install aiida-skeaf\nverdi quicksetup  # better to set up a new profile\nverdi plugin list aiida.calculations  # should now show your calclulation plugins\n```\n\n\n## Usage\n\nHere goes a [complete example](examples/example_01.py) of how to submit a test calculation using this plugin.\n\nA quick demo of how to submit a calculation:\n```shell\nverdi daemon start     # make sure the daemon is running\ncd examples\n./example_01.py        # run test calculation\nverdi process list -a  # check record of calculation\n```\n\nAn exemplary `verdi node show`:\n```\nProperty     Value\n-----------  ------------------------------------\ntype         SkeafCalculation\nstate        Finished [0]\npk           137264\nuuid         92d3ff92-9ab4-4828-9794-4172d7dcad50\nlabel\ndescription\nctime        2022-03-01 19:12:16.157988+00:00\nmtime        2022-03-01 19:13:28.369793+00:00\ncomputer     [2] localhost\n\nInputs          PK  Type\n----------  ------  ----------\nbxsf        137262  RemoteData\ncode        137230  Code\nparameters  137263  Dict\n\nOutputs                PK  Type\n-----------------  ------  ----------\nfrequency          137268  ArrayData\noutput_parameters  137267  Dict\nremote_folder      137265  RemoteData\nretrieved          137266  FolderData\n```\n\nA frequency vs angle plot can be found in [examples/results/example_01.png](examples/results/example_01.png)\n\n## Development\n\n```shell\ngit clone https://github.com/aiidaplugins/aiida-skeaf .\ncd aiida-skeaf\npip install flit\nflit install -s .[pre-commit,testing]  # install extra dependencies\npre-commit install  # install pre-commit hooks\npytest -v  # discover and run all tests\n```\n\nSee the [developer guide](http://aiida-skeaf.readthedocs.io/en/latest/developer_guide/index.html) for more information.\n\n## License\n\nMIT\n\n[ci-badge]: https://github.com/qiaojunfeng/aiida-skeaf/workflows/ci/badge.svg?branch=master\n[ci-link]: https://github.com/qiaojunfeng/aiida-skeaf/actions\n[cov-badge]: https://coveralls.io/repos/github/qiaojunfeng/aiida-skeaf/badge.svg?branch=master\n[cov-link]: https://coveralls.io/github/qiaojunfeng/aiida-skeaf?branch=master\n[docs-badge]: https://readthedocs.org/projects/aiida-skeaf/badge\n[docs-link]: http://aiida-skeaf.readthedocs.io/\n[pypi-badge]: https://badge.fury.io/py/aiida-skeaf.svg\n[pypi-link]: https://badge.fury.io/py/aiida-skeaf\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiidaplugins%2Faiida-skeaf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faiidaplugins%2Faiida-skeaf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faiidaplugins%2Faiida-skeaf/lists"}