https://github.com/juliankarlbauer/mechmean
Mean field methods in the context of continuum mechanics with special focus on orientation averaging homogenization
https://github.com/juliankarlbauer/mechmean
continuum-mechanics mean-field mean-field-theory mechanical-engineering mechanics python
Last synced: 8 months ago
JSON representation
Mean field methods in the context of continuum mechanics with special focus on orientation averaging homogenization
- Host: GitHub
- URL: https://github.com/juliankarlbauer/mechmean
- Owner: JulianKarlBauer
- License: mit
- Created: 2021-09-07T11:12:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-03T09:06:28.000Z (over 3 years ago)
- Last Synced: 2025-09-28T13:28:25.229Z (8 months ago)
- Topics: continuum-mechanics, mean-field, mean-field-theory, mechanical-engineering, mechanics, python
- Language: Python
- Homepage:
- Size: 2.76 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
[][url_pypi_this_package]
[][url_read_the_docs_latest]
[][url_latest_doi]
[](https://github.com/psf/black)
[](LICENSE)
[](https://mybinder.org/v2/gh/JulianKarlBauer/mechmean/HEAD)
# Mechmean
This Python package contains selected mean field methods
in the context of continuum mechanics
with special focus on orientation averaging homogenization
The implementation is oriented as close as possible to the cited references
and no emphasis is placed on run time optimization.
Therefore, this package should be considered as a reference implementation
which can be used to cross-validate performance-optimized implementation.
Please see [license][url_license],
[acknowledgment](#acknowledgment)
and cite the latest [Zenodo-DOI][url_latest_doi]
## Installation [][url_pypi_this_package]
Install with `pip` following instructions on [Python Package Index][url_pypi_this_package], i.e.,
```bash
pip install mechmean
```
**or** install from local files
- [Clone][url_how_to_clone] this repository to your machine
- Open a terminal and navigate to your local clone
- Install the package from the local clone into the current [env][url_env_python]i[ronment][url_env_conda] in develop mode:
```shell
python setup.py develop
```
Note: [Develop vs. install](https://stackoverflow.com/a/19048754/8935243)
## Examples
Both example notebooks and example scripts are rendered [here][url_read_the_docs_latest_notebooks] and given as source [here](docs/source/notebooks).
## Acknowledgment
The research documented in this repository has been funded by the
[German Research Foundation (DFG, Deutsche Forschungsgemeinschaft)][dfg_website] - project number [255730231][dfg_project].
The support by the German Research Foundation within the International Research Training Group
[“Integrated engineering of continuous-discontinuous long fiber reinforced polymer structures“ (GRK 2078)][grk_website]
is gratefully acknowledged.
[grk_website]: https://www.grk2078.kit.edu/
[dfg_website]: https://www.dfg.de/
[dfg_project]: https://gepris.dfg.de/gepris/projekt/255730231
[url_license]: LICENSE
[url_latest_doi]: https://zenodo.org/badge/latestdoi/403947937
[url_article]: ??
[url_how_to_clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
[url_env_python]: https://docs.python.org/3/tutorial/venv.html
[url_env_conda]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html
[url_read_the_docs_latest]: https://mechmean.readthedocs.io/en/latest/
[url_read_the_docs_latest_notebooks]: https://mechmean.readthedocs.io/en/latest/source/example_notebooks.html
[url_pypi_this_package]: https://pypi.org/project/mechmean/