# MiCoFaM
MiCoFaM (Micromechanical Composite Fatigue Modeler) is a model generator for creating representative volume elements (RVEs) consisting of fibre, interface and matrix phases for a given fiber volume content with randomized fiber placements. The application is provided as an ABAQUS plug-in.
## Downloading
Use GIT to get the latest code base. From the command line, use
```
git clone https://gitlab.dlr.de/dlr-sy/micofam micofam
```
If you check out the repository for the first time, you have to initialize all submodule dependencies first. Execute the following from within the repository.
```
git submodule update --init --recursive
```
To fetch all refererenced submodules, use
```
git submodule foreach --recursive 'git checkout $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo main)'
```
To update all refererenced submodules to the latest production level, use
```
git submodule foreach --recursive 'git pull origin $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo main)'
```
## Installation
MiCoFaM can be installed and updated directly using [pip](https://pypi.org/project/micofam/). Use
```
pip install micofam
```
to install the latest release. Alternatively,
MiCoFaM can be installed from source using [poetry](https://python-poetry.org). If you don't have [poetry](https://python-poetry.org) installed, run
```
pip install poetry --pre --upgrade
```
to install the latest version of [poetry](https://python-poetry.org) within your python environment. Use
```
poetry update
```
to update all dependencies in the lock file or directly execute
```
poetry install
```
to install all dependencies from the lock file. Last, you should be able to import MiCoFaM as a python package.
```python
import micofam
```
## Usage
Navigate to the local ./config folder and execute ABAQUS using
```
abaqus cae
```
ABAQUS CAE is now started with a modified plugin central directory already set. Alternatively, after installing the software through pip, display all available commands by using
```console
$ micofam --help
usage: MiCoFaM [-h] [-v] {info,start} ...
CLI commands for MiCoFaM.
positional arguments:
{info,start}
info Show the current version and system information.
start Launch MiCoFaM on the current system. Starts ABAQUS in the process by default.
options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
```
To launch the current software with a non-default graphical user interface backend, append a valid identifier to the start command. The backend `abaqus` if set by default.
```console
$ micofam start --help
usage: MiCoFaM start [-h] ...
positional arguments:
backend Backend application to start MiCoFaM. Defaults to abaqus.
options:
-h, --help show this help message and exit
```
For example, to start [MiCoFaM](https://gitlab.dlr.de/dlr-sy/micofam) with a `abq2023h5`, use
```
micofam start abq2023h5
```
## Contact
* [Caroline Lüders](mailto:caroline.lueders@dlr.de)
## Support
* [List of Contributors](CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/dlr-sy/micofam",
"name": "micofam",
"maintainer": "Garbade, Marc",
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
"maintainer_email": "marc.garbade@dlr.de",
"keywords": "analysis, micromechanics, rve",
"author": "Krause, Daniel",
"author_email": "daniel.krause@dlr.de",
"download_url": "https://files.pythonhosted.org/packages/56/ad/ca819e3faea95c04791a1df8d17a3e4ab48e293a906f09b4c7a4a2b1bc7d/micofam-1.1.0rc0.tar.gz",
"platform": null,
"description": "# MiCoFaM\nMiCoFaM (Micromechanical Composite Fatigue Modeler) is a model generator for creating representative volume elements (RVEs) consisting of fibre, interface and matrix phases for a given fiber volume content with randomized fiber placements. The application is provided as an ABAQUS plug-in.\n## Downloading\nUse GIT to get the latest code base. From the command line, use\n```\ngit clone https://gitlab.dlr.de/dlr-sy/micofam micofam\n```\nIf you check out the repository for the first time, you have to initialize all submodule dependencies first. Execute the following from within the repository. \n```\ngit submodule update --init --recursive\n```\nTo fetch all refererenced submodules, use\n```\ngit submodule foreach --recursive 'git checkout $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo main)'\n```\nTo update all refererenced submodules to the latest production level, use\n```\ngit submodule foreach --recursive 'git pull origin $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo main)'\n```\n## Installation\nMiCoFaM can be installed and updated directly using [pip](https://pypi.org/project/micofam/). Use\n```\npip install micofam\n```\nto install the latest release. Alternatively, \nMiCoFaM can be installed from source using [poetry](https://python-poetry.org). If you don't have [poetry](https://python-poetry.org) installed, run\n```\npip install poetry --pre --upgrade\n```\nto install the latest version of [poetry](https://python-poetry.org) within your python environment. Use\n```\npoetry update\n```\nto update all dependencies in the lock file or directly execute\n```\npoetry install\n```\nto install all dependencies from the lock file. Last, you should be able to import MiCoFaM as a python package.\n```python\nimport micofam\n```\n## Usage\nNavigate to the local ./config folder and execute ABAQUS using\n```\nabaqus cae\n```\nABAQUS CAE is now started with a modified plugin central directory already set. Alternatively, after installing the software through pip, display all available commands by using\n```console\n$ micofam --help\nusage: MiCoFaM [-h] [-v] {info,start} ...\n\nCLI commands for MiCoFaM.\n\npositional arguments:\n {info,start}\n info Show the current version and system information.\n start Launch MiCoFaM on the current system. Starts ABAQUS in the process by default.\n\noptions:\n -h, --help show this help message and exit\n -v, --version show program's version number and exit\n```\nTo launch the current software with a non-default graphical user interface backend, append a valid identifier to the start command. The backend `abaqus` if set by default.\n```console\n$ micofam start --help\nusage: MiCoFaM start [-h] ...\n\npositional arguments:\n backend Backend application to start MiCoFaM. Defaults to abaqus.\n\noptions:\n -h, --help show this help message and exit\n```\nFor example, to start [MiCoFaM](https://gitlab.dlr.de/dlr-sy/micofam) with a `abq2023h5`, use\n```\nmicofam start abq2023h5\n```\n## Contact\n* [Caroline L\u00fcders](mailto:caroline.lueders@dlr.de)\n## Support\n* [List of Contributors](CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Micromechanical Composite Fatigue Modeler",
"version": "1.1.0rc0",
"project_urls": {
"Homepage": "https://gitlab.com/dlr-sy/micofam",
"Repository": "https://gitlab.com/dlr-sy/micofam"
},
"split_keywords": [
"analysis",
" micromechanics",
" rve"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "844d4bf7eda34d551abcbdc64ba7cdfd9660300d3628657a1f12fcb5b2c9aca8",
"md5": "3a2410c71f468888e67afbd4040801b9",
"sha256": "64daf23bfb28c5ae8d3acf6185ea520e196c34d0da7c2ef87997640368bbd17f"
},
"downloads": -1,
"filename": "micofam-1.1.0rc0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a2410c71f468888e67afbd4040801b9",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
"size": 67855,
"upload_time": "2024-12-10T21:06:26",
"upload_time_iso_8601": "2024-12-10T21:06:26.591985Z",
"url": "https://files.pythonhosted.org/packages/84/4d/4bf7eda34d551abcbdc64ba7cdfd9660300d3628657a1f12fcb5b2c9aca8/micofam-1.1.0rc0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "56adca819e3faea95c04791a1df8d17a3e4ab48e293a906f09b4c7a4a2b1bc7d",
"md5": "a12120cb2db1777e490314868c344611",
"sha256": "0319eb6f8c4dc5138722b9e2f13db5641889d229d3db010471bb8572842e962b"
},
"downloads": -1,
"filename": "micofam-1.1.0rc0.tar.gz",
"has_sig": false,
"md5_digest": "a12120cb2db1777e490314868c344611",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7",
"size": 65438,
"upload_time": "2024-12-10T21:06:29",
"upload_time_iso_8601": "2024-12-10T21:06:29.294098Z",
"url": "https://files.pythonhosted.org/packages/56/ad/ca819e3faea95c04791a1df8d17a3e4ab48e293a906f09b4c7a4a2b1bc7d/micofam-1.1.0rc0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 21:06:29",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "dlr-sy",
"gitlab_project": "micofam",
"lcname": "micofam"
}
JSON