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 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 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.

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-1.5.4.tar.gz (64.1 kB view details)

Uploaded Source

Built Distribution

f3dasm-1.5.4-py3-none-any.whl (78.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: f3dasm-1.5.4.tar.gz
  • Upload date:
  • Size: 64.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for f3dasm-1.5.4.tar.gz
Algorithm Hash digest
SHA256 9d3cc3aef05e497158792a2fe751c460e748b51259fc93fb4dae2b2e60fb327e
MD5 f3fac137c40e2cae2d918edca6e25428
BLAKE2b-256 e0785cb8cb30fa5d270cc70fb1b52014001fcc67c23473ae9e2837038c78c06e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: f3dasm-1.5.4-py3-none-any.whl
  • Upload date:
  • Size: 78.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for f3dasm-1.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6265812c795b3c40480f2ee3c3a573837e40148945e0a1a596651eac9b0d129d
MD5 096c5f2bfe1076adf2286c45e6e95e05
BLAKE2b-256 c1ec025d33bd467cedfe1e9d5f6e3ddbb412926c34afa3abaaf6c407e8c9d761

See more details on using hashes here.

Supported by

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