f3dasm

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 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 Schelling¹

¹ 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 2024, Martin van der Schelling

All rights reserved.

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