Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/dataanalyticsengineering/aiida-fans

AiiDA plugin for FANS, an FFT-based homogenization solver.

https://github.com/dataanalyticsengineering/aiida-fans

Science Score: 26.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
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

AiiDA plugin for FANS, an FFT-based homogenization solver.

Basic Info
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 1
  • Open Issues: 8
  • Releases: 9
Created over 1 year ago · Last pushed 9 months ago
Metadata Files
Readme License

README.md

aiida-fans

PyPI Package Docs Status Build Status

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

  • [x] basic functionality capable of completing the example simulations presented by FANS with minimal database integration
  • [x] documentation hosted on aiida-fans.readthedocs.io
  • [x] documentation outline
  • [x] 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...

bash $ 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

  1. Branch off dev with a name appropriate for what you are working on (e.g. feat/myfeature or bug/badbug).
  2. Implement, commit, and push your changes.
  3. Open a Pull Request dev ← feat/myfeature, then merge and delete.

Release

  1. Open a Pull Request main ← dev, then squash and merge.
  2. Draft a new Release, named after the release version (e.g. v1.2.3).
  3. Create and assaign a new Tag, identically named.
  4. Generate release notes and publish.

Contact

You can contact ethan.shanahan@gmail.com with regard to this plugin specifically.

Owner

  • Name: DataAnalyticsEngineering
  • Login: DataAnalyticsEngineering
  • Kind: organization

GitHub Events

Total
  • Create event: 5
  • Release event: 1
  • Issues event: 4
  • Delete event: 4
  • Issue comment event: 4
  • Push event: 6
  • Pull request event: 10
Last Year
  • Create event: 5
  • Release event: 1
  • Issues event: 4
  • Delete event: 4
  • Issue comment event: 4
  • Push event: 6
  • Pull request event: 10

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 3
  • Total pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 minutes
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 7
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 minutes
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ethan-shanahan (2)
  • sanathkeshav (1)
Pull Request Authors
  • ethan-shanahan (5)
  • sanathkeshav (2)
Top Labels
Issue Labels
documentation (1) prio:low (1)
Pull Request Labels