f3dasm

f3dasm: Framework for Data-Driven Design and Analysis of Structures and Materials - Published in JOSS (2024)

https://github.com/bessagroup/f3dasm

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 9 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: wiley.com, joss.theoj.org
○
Committers with academic emails
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

computational-mechanics data-driven design-of-experiments framework machine-learning materials-science

Scientific Fields

Earth and Environmental Sciences Physical Sciences - 62% confidence

Last synced: 4 months ago · JSON representation ·

Repository

Framework for Data-Driven Design & Analysis of Structures & Materials (F3DASM)

Basic Info

Host: GitHub
Owner: bessagroup
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: https://f3dasm.readthedocs.io/
Size: 48.7 MB

Statistics

Stars: 123
Watchers: 4
Forks: 31
Open Issues: 35
Releases: 20

Topics

computational-mechanics data-driven design-of-experiments framework machine-learning materials-science

Created over 6 years ago · Last pushed 4 months ago

Metadata Files

Readme Contributing License Code of conduct Citation

f3dasm

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:

```bash

PyPI

$ pip install f3dasm ```

```bash

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

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

Owner

Name: Bessa Research Group
Login: bessagroup
Kind: organization
Email: miguel_bessa@brown.edu
Location: United States of America

Twitter: MiguelABessa
Repositories: 2
Profile: https://github.com/bessagroup

Machine Intelligence Advances for Materials & Structures

JOSS Publication

f3dasm: Framework for Data-Driven Design and Analysis of Structures and Materials

Published

August 16, 2024

DOI

10.21105/joss.06912

Volume 9, Issue 100, Page 6912

Authors

M. P. van der Schelling

Materials Science & Engineering, Delft University of Technology, the Netherlands

B. P. Ferreira

School of Engineering, Brown University, United States of America

M. A. Bessa

School of Engineering, Brown University, United States of America

Editor

Rocco Meli

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Schelling
  given-names: M. P.
  name-particle: van der
  orcid: "https://orcid.org/0000-0003-3602-0452"
- family-names: Ferreira
  given-names: B. P.
  orcid: "https://orcid.org/0000-0001-5956-3877"
- family-names: Bessa
  given-names: M. A.
  orcid: "https://orcid.org/0000-0002-6216-0355"
contact:
- family-names: Bessa
  given-names: M. A.
  orcid: "https://orcid.org/0000-0002-6216-0355"
doi: 10.5281/zenodo.13227915
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Schelling
    given-names: M. P.
    name-particle: van der
    orcid: "https://orcid.org/0000-0003-3602-0452"
  - family-names: Ferreira
    given-names: B. P.
    orcid: "https://orcid.org/0000-0001-5956-3877"
  - family-names: Bessa
    given-names: M. A.
    orcid: "https://orcid.org/0000-0002-6216-0355"
  date-published: 2024-08-16
  doi: 10.21105/joss.06912
  issn: 2475-9066
  issue: 100
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6912
  title: "f3dasm: Framework for Data-Driven Design and Analysis of
    Structures and Materials"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.06912"
  volume: 9
title: "f3dasm: Framework for Data-Driven Design and Analysis of
  Structures and Materials"

GitHub Events

Total

Create event: 7
Release event: 2
Issues event: 26
Watch event: 14
Delete event: 6
Issue comment event: 9
Push event: 89
Pull request event: 9
Fork event: 4

Last Year

Create event: 7
Release event: 2
Issues event: 26
Watch event: 14
Delete event: 6
Issue comment event: 9
Push event: 91
Pull request event: 9
Fork event: 4

Committers

Last synced: 5 months ago

All Time

Total Commits: 947
Total Committers: 5
Avg Commits per committer: 189.4
Development Distribution Score (DDS): 0.01

Past Year

Commits: 116
Committers: 2
Avg Commits per committer: 58.0
Development Distribution Score (DDS): 0.009

Top Committers

Name	Email	Commits
Martin van der Schelling	6****g	938
Guillaume Broggi	2****i	6
llguo95	l**9@g**m	1
Rocco Meli	r**i@b**h	1
Martin van der Schelling	m**l@h**c	1

Committer Domains (Top 20 + Academic)

hpc06.hpc: 1 bluemail.ch: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 145
Total pull requests: 128
Average time to close issues: 5 months
Average time to close pull requests: 28 days
Total issue authors: 10
Total pull request authors: 10
Average comments per issue: 0.46
Average comments per pull request: 0.32
Merged pull requests: 92
Bot issues: 0
Bot pull requests: 15

Past Year

Issues: 20
Pull requests: 12
Average time to close issues: 28 days
Average time to close pull requests: 16 days
Issue authors: 3
Pull request authors: 1
Average comments per issue: 0.2
Average comments per pull request: 0.0
Merged pull requests: 7
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

mpvanderschelling (81)
llguo95 (23)
manuGil (10)
SNMS95 (10)
GuillaumeBroggi (8)
maxkukkola (4)
JiaxiangYi96 (3)
h-vijayakumaran (3)
vanlinn (2)
elvisbr0wn (1)

Pull Request Authors

mpvanderschelling (94)
dependabot[bot] (15)
GuillaumeBroggi (6)
JiaxiangYi96 (3)
SNMS95 (3)
RMeli (2)
llguo95 (2)
manuGil (1)
shushu-qin (1)
gawelk (1)

Top Labels

Issue Labels

documentation (15) enhancement (11) feature (8) bug (6) help wanted (2) question (1)

Pull Request Labels

dependencies (15) to main (3) feature (1) enhancement (1)

Packages

Total packages: 1
Total downloads:
- pypi 397 last-month

Total dependent packages: 2
Total dependent repositories: 1
Total versions: 40
Total maintainers: 2

pypi.org: f3dasm

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

Homepage: https://github.com/bessagroup/f3dasm
Documentation: https://f3dasm.readthedocs.io/
License: BSD-3-Clause
Latest release: 2.0.2
published 4 months ago

Versions: 40
Dependent Packages: 2
Dependent Repositories: 1
Downloads: 397 Last month

Rankings

Dependent packages count: 7.4%

Stargazers count: 7.7%

Forks count: 7.8%

Downloads: 9.3%

Average: 10.9%

Dependent repos count: 22.2%

Maintainers (2)

bessagroup mpvanderschelling

Last synced: 4 months ago

Dependencies

docs/requirements.txt pypi

sphinx *
sphinx_autodoc_typehints *
sphinx_rtd_theme *
sphinxcontrib-bibtex *

.github/workflows/draft-pdf.yml actions

actions/checkout v3 composite
actions/upload-artifact v1 composite
openjournals/openjournals-draft-action master composite

.github/workflows/pr_to_pr.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/pr_to_main.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/push_to_main.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
peaceiris/actions-gh-pages v3 composite

pyproject.toml pypi

requirements.txt pypi

SALib *
autograd *
filelock *
hydra-core *
matplotlib *
numpy *
pandas *
pathos >=0.3.0
scipy *
xarray *

requirements_dev.txt pypi

build * development
flake8 * development
setuptools >=43.0.0 development
wheel * development

tests/requirements.txt pypi

hypothesis * test
pytest * test
pytest-cov * test

f3dasm

Science Score: 98.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

f3dasm

Summary

Getting started

PyPI

PyPI

Illustrative benchmarks

Authorship & Citation

Community Support

License

Owner

JOSS Publication

f3dasm: Framework for Data-Driven Design and Analysis of Structures and Materials

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: f3dasm

Rankings

Maintainers (2)

Dependencies