f3dasm

Welcome to the documentation page of the ‘Framework for Data-Driven Design and Analysis of Structures and Materials’. Here you will find all information on installing, using and contributing to the Python package.

Basic Concepts

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 of are:

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 integrated with hydra configuration manager, to easily manage and run experiments.

Getting started

The best way to get started is to:

Read the Overview section, containing a brief introduction to the framework and a statement of need.
Follow the Installation instructions to get going!
Check out the Tutorials section, containing a collection of examples to get you familiar with the framework.

Authorship & Citation

f3dasm is created and maintained by Martin van der Schelling [1].

Contribute

f3dasm is an open-source project, and contributions of any kind are welcome and appreciated. If you want to contribute, please go to the GitHub wiki page.

Useful links

GitHub repository (source code)
Wiki for development
PyPI package (distribution package)

License

f3dasm is a free and open-source software published under a BSD 3-Clause License.