AiiDA plugin for FANS, an FFT-based homogenization solver.
Project description
aiida-fans
This is a plugin for AiiDA that facilitates the use of FANS. FANS is an FFT-based homogenisation solver for microscale and multiphysics problems. It is an open-source project under active development at the Institute of Applied Mechanics, University of Stuttgart. This plugin aims to bring the full value of provenance tracking and database integration to the results produced by FANS.
The design goals of this plugin are primarily to provide as simplistic a user experience as is reasonably possible. Secondarily, more featureful additions will be made to extend the users' options for queryability and optimisation.
Upcoming
Please note: This plugin is currently in the planning stage of development, with substantial contributions coming soon.
Pre-launch
- basic functionality capable of completing the example simulations presented by FANS with minimal database integration
- documentation hosted on aiida-fans.readthedocs.io
- documentation outline
- publish package on PyPI
Post-launch
- documentation expansion
- input validation developed in cooperation with the FANS team
- file sharing optimisations
- greater database integration via output analysis/extraction
Installation
The plugin is currently unavailable via PyPI at this stage in development, but it is intended to be published upon an upcoming functional release.
The package can always be installed by cloning this repository and installing it locally like so...
$ pip install ./aiida-fans
You must also ensure that FANS, AiiDA, and their various dependencies are installed. Please consult the FANS repository and the AiiDA installation guide for more information.
Contributing
Development
- Branch off
devwith a name appropriate for what you are working on (e.g.feat/myfeatureorbug/badbug). - Implement, commit, and push your changes.
- Open a Pull Request
dev ← feat/myfeature, then merge and delete.
Release
- Open a Pull Request
main ← dev, then squash and merge. - Draft a new Release, named after the release version (e.g. v1.2.3).
- Create and assaign a new Tag, identically named.
- Generate release notes and publish.
Contact
You can contact ethan.shanahan@gmail.com with regard to this plugin specifically.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aiida_fans-0.2.1.tar.gz.
File metadata
- Download URL: aiida_fans-0.2.1.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
225a5a106c0cee2249edd3d61815bedfa763a0dbf8421716bb5dd6b4283e9628
|
|
| MD5 |
55bc671c9026ae9286655b45cbe3e27e
|
|
| BLAKE2b-256 |
9afc6b1004c07dc4c7aef7a9c900ffe142841191ec1074d191ef083cf2ff924e
|
Provenance
The following attestation bundles were made for aiida_fans-0.2.1.tar.gz:
Publisher:
release.yml on DataAnalyticsEngineering/AiiDA-FANS
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiida_fans-0.2.1.tar.gz -
Subject digest:
225a5a106c0cee2249edd3d61815bedfa763a0dbf8421716bb5dd6b4283e9628 - Sigstore transparency entry: 487895446
- Sigstore integration time:
-
Permalink:
DataAnalyticsEngineering/AiiDA-FANS@1ad6a858086dc949511505c03452c5104afba3ef -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/DataAnalyticsEngineering
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@1ad6a858086dc949511505c03452c5104afba3ef -
Trigger Event:
release
-
Statement type:
File details
Details for the file aiida_fans-0.2.1-py3-none-any.whl.
File metadata
- Download URL: aiida_fans-0.2.1-py3-none-any.whl
- Upload date:
- Size: 12.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e008b081f2a42d43562ebc1e68e3d1a6ba0c676a7f95da96715822aba5c2bf9
|
|
| MD5 |
fd1471affadbd66094a4f8590337ea3a
|
|
| BLAKE2b-256 |
c9cb29ae0e6797cffdb308eb2ec35f10b5a88487434911698d160661dcb715ec
|
Provenance
The following attestation bundles were made for aiida_fans-0.2.1-py3-none-any.whl:
Publisher:
release.yml on DataAnalyticsEngineering/AiiDA-FANS
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiida_fans-0.2.1-py3-none-any.whl -
Subject digest:
5e008b081f2a42d43562ebc1e68e3d1a6ba0c676a7f95da96715822aba5c2bf9 - Sigstore transparency entry: 487895466
- Sigstore integration time:
-
Permalink:
DataAnalyticsEngineering/AiiDA-FANS@1ad6a858086dc949511505c03452c5104afba3ef -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/DataAnalyticsEngineering
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@1ad6a858086dc949511505c03452c5104afba3ef -
Trigger Event:
release
-
Statement type:
