Skip to main content

f3dasm - Framework for Data-driven Development and Analysis of Structures and Materials

Project description

f3dasm


DOI Python pypi Conda Version GitHub license Documentation Status

Docs | Installation | GitHub | PyPI | Conda | Paper

Summary

Welcome to f3dasm, a framework for data-driven design and analysis of structures and materials.

f3dasm introduces a general and user-friendly data-driven Python package for researchers and practitioners working on design and analysis of materials and structures. Some of the key features include:

  • Modular design

    • The framework introduces flexible interfaces, allowing users to easily integrate their own models and algorithms.
  • Automatic data management

    • The framework automatically manages I/O processes, saving you time and effort implementing these common procedures.
  • Easy parallelization

    • The framework manages parallelization of experiments, and is compatible with both local and high-performance cluster computing.
  • Built-in defaults

    • The framework includes a collection of benchmark functions, optimization algorithms and sampling strategies to get you started right away!
  • Hydra integration

    • The framework is supports the hydra configuration manager, to easily manage and run experiments.

Getting started

f3dasm is available at the Python Package Index and on Anaconda Cloud. To get started:

# PyPI
$ pip install f3dasm

or

# PyPI
$ conda install conda-forge::f3dasm
  • Follow the complete installation instructions to get going!
  • Read the overview section, containing a brief introduction to the framework and a statement of need.
  • Check out the tutorials section, containing a collection of examples to get you familiar with the framework.

Illustrative benchmarks

This package includes a collection of illustrative benchmark studies that demonstrate the capabilities of the framework. These studies are available in the /studies/ folder, and include the following studies:

  • Benchmarking optimization algorithms against well-known benchmark functions
  • 'Fragile Becomes Supercompressible' (Bessa et al. (2019))

Authorship & Citation

Current creator and developer: M.P. van der Schelling1

1 Doctoral Researcher in Materials Science and Engineering, Delft University of Technology: ORCID, Website

If you use f3dasm in your research or in a scientific publication, it is appreciated that you cite the paper below:

Journal of Open Source Software (paper):

@article{vanderSchelling2024,
  title = {f3dasm: Framework for Data-Driven Design and Analysis of Structures and Materials},
  author = {M. P. van der Schelling and B. P. Ferreira and M. A. Bessa},
  doi = {10.21105/joss.06912},
  url = {https://doi.org/10.21105/joss.06912},
  year = {2024},
  publisher = {The Open Journal},
  volume = {9},
  number = {100},
  pages = {6912},
  journal = {Journal of Open Source Software}
}

The Bessa research group at TU Delft is small... At the moment, we have limited availability to help future users/developers adapting the code to new problems, but we will do our best to help!

Community Support

If you find any issues, bugs or problems with this template, please use the GitHub issue tracker to report them.

License

Copyright 2025, Martin van der Schelling

All rights reserved.

This project is licensed under the BSD 3-Clause License. See LICENSE for the full license text.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

f3dasm-2.0.2.tar.gz (49.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

f3dasm-2.0.2-py3-none-any.whl (57.1 kB view details)

Uploaded Python 3

File details

Details for the file f3dasm-2.0.2.tar.gz.

File metadata

  • Download URL: f3dasm-2.0.2.tar.gz
  • Upload date:
  • Size: 49.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for f3dasm-2.0.2.tar.gz
Algorithm Hash digest
SHA256 621b1871bfa590a5a321a7e5f76e8fb4897693f4765e0a05e372a466e3fe6501
MD5 2732007748be3e2e4a9f250a07c8b552
BLAKE2b-256 46d432271bbb2ede40807de9471a4a53a6c9de6e54d028ed5b8caa85260cef7c

See more details on using hashes here.

Provenance

The following attestation bundles were made for f3dasm-2.0.2.tar.gz:

Publisher: release.yaml on bessagroup/f3dasm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file f3dasm-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: f3dasm-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 57.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for f3dasm-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6d6be35b45699d0e11f4c200bb99882e76290a3b51eb6fea7c7dfa998ea69a92
MD5 1441d0535f6799512903fc8d643ac51c
BLAKE2b-256 4b6c14ef6363150db23a31f65d60cf99111d5474de856f101d4d957d91f9d76c

See more details on using hashes here.

Provenance

The following attestation bundles were made for f3dasm-2.0.2-py3-none-any.whl:

Publisher: release.yaml on bessagroup/f3dasm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page