f3dasm
------
<div align="center"><img src="https://raw.githubusercontent.com/bessagroup/f3dasm/main/logo.png" width="800"/></div>
***
[](https://joss.theoj.org/papers/b0a25f75a32ae95a0a75bf3118952a5d)
[](https://www.python.org)
[](https://pypi.org/project/f3dasm/)
[](https://anaconda.org/conda-forge/f3dasm)
[](https://github.com/bessagroup/f3dasm)
[](https://f3dasm.readthedocs.io/en/latest/?badge=latest)
[**Docs**](https://f3dasm.readthedocs.io/)
| [**Installation**](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html)
| [**GitHub**](https://github.com/bessagroup/f3dasm)
| [**PyPI**](https://pypi.org/project/f3dasm/)
| [**Conda**](https://anaconda.org/conda-forge/f3dasm)
| [**Paper**](https://doi.org/10.21105/joss.06912)
## Summary
Welcome to `f3dasm`, a **f**ramework for **d**ata-**d**riven **d**esign and **a**nalysis of **s**tructures and **m**aterials.
`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](https://hydra.cc/) configuration manager, to easily manage and run experiments.
## Getting started
`f3dasm` is available at [the Python Package Index]() and on [Anaconda Cloud](https://anaconda.org/conda-forge/f3dasm). To get started:
```bash
# PyPI
$ pip install f3dasm
```
or
```bash
# PyPI
$ conda install f3dasm
```
* Follow the complete [installation instructions](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) to get going!
* Read the [overview](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) section, containing a brief introduction to the framework and a statement of need.
* Check out the [tutorials](https://f3dasm.readthedocs.io/en/latest/auto_examples/index.html) 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)](https://onlinelibrary.wiley.com/doi/full/10.1002/adma.201904845))
## Authorship & Citation
Current creator and developer: M.P. van der Schelling<sup>[1](#f1)</sup>
<sup id="f1"> 1 </sup>Doctoral Researcher in Materials Science and Engineering, Delft University of Technology: [ORCID](https://orcid.org/0000-0003-3602-0452), [Website](https://github.com/mpvanderschelling/)
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](https://doi.org/10.21105/joss.06912)):
```
@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](https://github.com/bessagroup/f3dasm/issues) 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](https://github.com/bessagroup/f3dasm/blob/main/LICENSE) for the full license text.
Raw data
{
"_id": null,
"home_page": "https://github.com/bessagroup/f3dasm",
"name": "f3dasm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "data-driven materials framework, machine learning",
"author": "Martin van der Schelling",
"author_email": "M.P.vanderSchelling@tudelft.nl",
"download_url": "https://files.pythonhosted.org/packages/e0/78/5cb8cb30fa5d270cc70fb1b52014001fcc67c23473ae9e2837038c78c06e/f3dasm-1.5.4.tar.gz",
"platform": null,
"description": "f3dasm\n------\n\n<div align=\"center\"><img src=\"https://raw.githubusercontent.com/bessagroup/f3dasm/main/logo.png\" width=\"800\"/></div>\n\n***\n\n[](https://joss.theoj.org/papers/b0a25f75a32ae95a0a75bf3118952a5d)\n[](https://www.python.org)\n[](https://pypi.org/project/f3dasm/)\n[](https://anaconda.org/conda-forge/f3dasm)\n[](https://github.com/bessagroup/f3dasm)\n[](https://f3dasm.readthedocs.io/en/latest/?badge=latest)\n\n[**Docs**](https://f3dasm.readthedocs.io/)\n| [**Installation**](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html)\n| [**GitHub**](https://github.com/bessagroup/f3dasm)\n| [**PyPI**](https://pypi.org/project/f3dasm/)\n| [**Conda**](https://anaconda.org/conda-forge/f3dasm)\n| [**Paper**](https://doi.org/10.21105/joss.06912)\n\n## Summary\n\nWelcome to `f3dasm`, a **f**ramework for **d**ata-**d**riven **d**esign and **a**nalysis of **s**tructures and **m**aterials.\n\n`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:\n\n- **Modular design** \n - The framework introduces flexible interfaces, allowing users to easily integrate their own models and algorithms.\n\n- **Automatic data management**\n - The framework automatically manages I/O processes, saving you time and effort implementing these common procedures.\n\n- **Easy parallelization**\n - The framework manages parallelization of experiments, and is compatible with both local and high-performance cluster computing.\n\n- **Built-in defaults**\n - The framework includes a collection of benchmark functions, optimization algorithms and sampling strategies to get you started right away!\n\n- **Hydra integration**\n - The framework is supports the [hydra](https://hydra.cc/) configuration manager, to easily manage and run experiments.\n\n\n## Getting started\n\n`f3dasm` is available at [the Python Package Index]() and on [Anaconda Cloud](https://anaconda.org/conda-forge/f3dasm). To get started:\n\n```bash\n# PyPI\n$ pip install f3dasm\n```\n\nor\n\n```bash\n# PyPI\n$ conda install f3dasm\n```\n\n* Follow the complete [installation instructions](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) to get going!\n* Read the [overview](https://f3dasm.readthedocs.io/en/latest/rst_doc_files/general/installation.html) section, containing a brief introduction to the framework and a statement of need.\n* Check out the [tutorials](https://f3dasm.readthedocs.io/en/latest/auto_examples/index.html) section, containing a collection of examples to get you familiar with the framework.\n\n## Illustrative benchmarks\n\nThis 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:\n\n- Benchmarking optimization algorithms against well-known benchmark functions\n- 'Fragile Becomes Supercompressible' ([Bessa et al. (2019)](https://onlinelibrary.wiley.com/doi/full/10.1002/adma.201904845))\n\n## Authorship & Citation\n\nCurrent creator and developer: M.P. van der Schelling<sup>[1](#f1)</sup>\n\n<sup id=\"f1\"> 1 </sup>Doctoral Researcher in Materials Science and Engineering, Delft University of Technology: [ORCID](https://orcid.org/0000-0003-3602-0452), [Website](https://github.com/mpvanderschelling/)\n\nIf you use `f3dasm` in your research or in a scientific publication, it is appreciated that you cite the paper below:\n\n**Journal of Open Source Software** ([paper](https://doi.org/10.21105/joss.06912)):\n```\n@article{vanderSchelling2024,\n title = {f3dasm: Framework for Data-Driven Design and Analysis of Structures and Materials},\n author = {M. P. van der Schelling and B. P. Ferreira and M. A. Bessa},\n doi = {10.21105/joss.06912},\n url = {https://doi.org/10.21105/joss.06912},\n year = {2024},\n publisher = {The Open Journal},\n volume = {9},\n number = {100},\n pages = {6912},\n journal = {Journal of Open Source Software}\n}\n```\n\nThe 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!\n\n## Community Support\n\nIf you find any **issues, bugs or problems** with this template, please use the [GitHub issue tracker](https://github.com/bessagroup/f3dasm/issues) to report them.\n\n## License\n\nCopyright 2024, Martin van der Schelling\n\nAll rights reserved.\n\nThis project is licensed under the BSD 3-Clause License. See [LICENSE](https://github.com/bessagroup/f3dasm/blob/main/LICENSE) for the full license text.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "f3dasm - Framework for Data-driven Development and Analysis of Structures and Materials",
"version": "1.5.4",
"project_urls": {
"Documentation": "https://f3dasm.readthedocs.io/",
"Homepage": "https://github.com/bessagroup/f3dasm",
"Wiki": "https://github.com/bessagroup/f3dasm/wiki"
},
"split_keywords": [
"data-driven materials framework",
" machine learning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1ec025d33bd467cedfe1e9d5f6e3ddbb412926c34afa3abaaf6c407e8c9d761",
"md5": "096c5f2bfe1076adf2286c45e6e95e05",
"sha256": "6265812c795b3c40480f2ee3c3a573837e40148945e0a1a596651eac9b0d129d"
},
"downloads": -1,
"filename": "f3dasm-1.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "096c5f2bfe1076adf2286c45e6e95e05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 78394,
"upload_time": "2024-10-09T12:54:39",
"upload_time_iso_8601": "2024-10-09T12:54:39.287463Z",
"url": "https://files.pythonhosted.org/packages/c1/ec/025d33bd467cedfe1e9d5f6e3ddbb412926c34afa3abaaf6c407e8c9d761/f3dasm-1.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0785cb8cb30fa5d270cc70fb1b52014001fcc67c23473ae9e2837038c78c06e",
"md5": "f3fac137c40e2cae2d918edca6e25428",
"sha256": "9d3cc3aef05e497158792a2fe751c460e748b51259fc93fb4dae2b2e60fb327e"
},
"downloads": -1,
"filename": "f3dasm-1.5.4.tar.gz",
"has_sig": false,
"md5_digest": "f3fac137c40e2cae2d918edca6e25428",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 64131,
"upload_time": "2024-10-09T12:54:41",
"upload_time_iso_8601": "2024-10-09T12:54:41.364515Z",
"url": "https://files.pythonhosted.org/packages/e0/78/5cb8cb30fa5d270cc70fb1b52014001fcc67c23473ae9e2837038c78c06e/f3dasm-1.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 12:54:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bessagroup",
"github_project": "f3dasm",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "f3dasm"
}
JSON
