fedoo


Namefedoo JSON
Version 0.2.2 PyPI version JSON
download
home_pageNone
SummaryFinite elements library
upload_time2024-07-25 14:33:41
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseGPLv3
keywords fem structural mechanics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # fedoo
Finite element library
[![FEDOO Logo](https://github.com/3MAH/fedoo/blob/master/fedOOLogos.png)](https://github.com/3MAH/fedoo)

About
-----

Fedoo is an open source Finite Element library developed in Python.
It is mainly dedicated for mechanical problems but is easily developpable for other kind of problems (thermal laws already includes).
One of the main application of fedoo is to simulate the mechanical response of heterogeneous materials. 
For that purpose, fedoo is part of the 3mah set that also include microgen for the CAD and meshing of heterogeneous materials 
and simcoon for the non linear material constitutive models in finite strain. 

Here are the main features:

- Entirely written in Python 3
- Implicit finite element Solver for Static and Dynamics poblems
- Finite strain constitutive laws based on the simcoon library (simcoon is developped in C++ allowing a fast execution)
- Geometrical non linearities based on the simcoon library 
- Wide constitutive equation library including composites law, elasto-plastic law, ...
- Include many types of elements like 2D, 3D, beam, plate, cohesive elements, ...
- Homogeneisation: Easy application of periodic boundary conditions and fast automatic extraction of mean tangent matrices
- Embedded results visualization using the powerfull pyvista library
- Multi-point constraints
- Easy scripting
- Good compromise between a reasonable execution time and an open and lisible code. fedoo is not the fastest finite element software and doesn't intend to be, but a particular attention is paid 
  to the computational cost.
- Contact in 2D and 3D, Self contact
- And many other....

|               |                                                                                                                                        |
|---------------|----------------------------------------------------------------------------------------------------------------------------------------|
| PyPI package  | [![PyPI version](https://badge.fury.io/py/fedoo.svg)](https://badge.fury.io/py/fedoo)                                                  |
| Conda package | [![Conda](https://anaconda.org/set3mah/fedoo/badges/version.svg)](https://anaconda.org/set3mah/fedoo)                                  |
| Documentation | [![Documentation](https://readthedocs.org/projects/fedoo/badge/?version=latest)](https://fedoo.readthedocs.io/en/latest/?badge=latest) |
| License       | [![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)                                |
| Website       | [![Website](https://img.shields.io/badge/website-3MAH-blue)](https://3mah.github.io/)                                                  |


Documentation
--------------
The [documentation](https://fedoo.readthedocs.io/en/latest/?badge=latest) is provided by readthedocs at
[https://fedoo.readthedocs.io](https://fedoo.readthedocs.io).


Installation
--------------
Installation with pip including recommanded dependencies excepted simcoon:
```
pip install fedoo[all]
```

Minimal installation with pip:
```
pip install fedoo
```

Installation with conda with recommanded dependencices (including simcoon): 
```
conda install -c conda-forge -c set3mah fedoo
```
In mac OS make sure to use scikit-umfpack, the best way to take the most of MacOs accelerate framework is to install numpy from sources first:
```
pip install cython pybind11
pip install --no-binary :all: numpy
```
The conda package is restricted to version 0.33, which is not compatible with the latest versions of numpy
```
pip install scikit-umpack>=0.41 
```

For performance considerations, it is in general strongly recommended to make sure that numpy is correctly using a fast implementation of BLAS : ou can do
```
import numpy
numpy.show_config()
```
to check this, and use either *MKL* or *Accelerate* implementation of BLAS

Also, make sure that the default number of threads is not leading to performance degradations: using explicit number of threads might help, see below for extensive control of threads number
```
#Set the number of threads
import os

n_threads = 4
os.environ["OMP_NUM_THREADS"] = f"{n_threads}"
os.environ["OPENBLAS_NUM_THREADS"] = f"{n_threads}"
os.environ["MKL_NUM_THREADS"] = f"{n_threads}"
os.environ["VECLIB_MAXIMUM_THREADS"] = f"{n_threads}"
os.environ["NUMEXPR_NUM_THREADS"] = f"{n_threads}"
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fedoo",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "FEM, Structural mechanics",
    "author": null,
    "author_email": "3MAH <set3mah@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/bd/9f/7d62b652193535d485c64cf40b483ba5b5e7406ab4014508ce052a9d3d4d/fedoo-0.2.2.tar.gz",
    "platform": null,
    "description": "# fedoo\nFinite element library\n[![FEDOO Logo](https://github.com/3MAH/fedoo/blob/master/fedOOLogos.png)](https://github.com/3MAH/fedoo)\n\nAbout\n-----\n\nFedoo is an open source Finite Element library developed in Python.\nIt is mainly dedicated for mechanical problems but is easily developpable for other kind of problems (thermal laws already includes).\nOne of the main application of fedoo is to simulate the mechanical response of heterogeneous materials. \nFor that purpose, fedoo is part of the 3mah set that also include microgen for the CAD and meshing of heterogeneous materials \nand simcoon for the non linear material constitutive models in finite strain. \n\nHere are the main features:\n\n- Entirely written in Python 3\n- Implicit finite element Solver for Static and Dynamics poblems\n- Finite strain constitutive laws based on the simcoon library (simcoon is developped in C++ allowing a fast execution)\n- Geometrical non linearities based on the simcoon library \n- Wide constitutive equation library including composites law, elasto-plastic law, ...\n- Include many types of elements like 2D, 3D, beam, plate, cohesive elements, ...\n- Homogeneisation: Easy application of periodic boundary conditions and fast automatic extraction of mean tangent matrices\n- Embedded results visualization using the powerfull pyvista library\n- Multi-point constraints\n- Easy scripting\n- Good compromise between a reasonable execution time and an open and lisible code. fedoo is not the fastest finite element software and doesn't intend to be, but a particular attention is paid \n  to the computational cost.\n- Contact in 2D and 3D, Self contact\n- And many other....\n\n|               |                                                                                                                                        |\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| PyPI package  | [![PyPI version](https://badge.fury.io/py/fedoo.svg)](https://badge.fury.io/py/fedoo)                                                  |\n| Conda package | [![Conda](https://anaconda.org/set3mah/fedoo/badges/version.svg)](https://anaconda.org/set3mah/fedoo)                                  |\n| Documentation | [![Documentation](https://readthedocs.org/projects/fedoo/badge/?version=latest)](https://fedoo.readthedocs.io/en/latest/?badge=latest) |\n| License       | [![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)                                |\n| Website       | [![Website](https://img.shields.io/badge/website-3MAH-blue)](https://3mah.github.io/)                                                  |\n\n\nDocumentation\n--------------\nThe [documentation](https://fedoo.readthedocs.io/en/latest/?badge=latest) is provided by readthedocs at\n[https://fedoo.readthedocs.io](https://fedoo.readthedocs.io).\n\n\nInstallation\n--------------\nInstallation with pip including recommanded dependencies excepted simcoon:\n```\npip install fedoo[all]\n```\n\nMinimal installation with pip:\n```\npip install fedoo\n```\n\nInstallation with conda with recommanded dependencices (including simcoon): \n```\nconda install -c conda-forge -c set3mah fedoo\n```\nIn mac OS make sure to use scikit-umfpack, the best way to take the most of MacOs accelerate framework is to install numpy from sources first:\n```\npip install cython pybind11\npip install --no-binary :all: numpy\n```\nThe conda package is restricted to version 0.33, which is not compatible with the latest versions of numpy\n```\npip install scikit-umpack>=0.41 \n```\n\nFor performance considerations, it is in general strongly recommended to make sure that numpy is correctly using a fast implementation of BLAS : ou can do\n```\nimport numpy\nnumpy.show_config()\n```\nto check this, and use either *MKL* or *Accelerate* implementation of BLAS\n\nAlso, make sure that the default number of threads is not leading to performance degradations: using explicit number of threads might help, see below for extensive control of threads number\n```\n#Set the number of threads\nimport os\n\nn_threads = 4\nos.environ[\"OMP_NUM_THREADS\"] = f\"{n_threads}\"\nos.environ[\"OPENBLAS_NUM_THREADS\"] = f\"{n_threads}\"\nos.environ[\"MKL_NUM_THREADS\"] = f\"{n_threads}\"\nos.environ[\"VECLIB_MAXIMUM_THREADS\"] = f\"{n_threads}\"\nos.environ[\"NUMEXPR_NUM_THREADS\"] = f\"{n_threads}\"\n```\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Finite elements library",
    "version": "0.2.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/3MAH/fedoo/issues",
        "Documentation": "https://fedoo.readthedocs.io/en/latest/",
        "Source Code": "https://github.com/3MAH/fedoo"
    },
    "split_keywords": [
        "fem",
        " structural mechanics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1836fa2246b9d262549f3d824e095bb963e48c638bbf1a252eea2955a00e3ea6",
                "md5": "3247d18c0550e585e1ace83c5edd377a",
                "sha256": "212f1fc0336ea7e8f8696060f1d4732c758c0a88da7ca916c83bba9f5aead2c3"
            },
            "downloads": -1,
            "filename": "fedoo-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3247d18c0550e585e1ace83c5edd377a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 292685,
            "upload_time": "2024-07-25T14:33:39",
            "upload_time_iso_8601": "2024-07-25T14:33:39.028591Z",
            "url": "https://files.pythonhosted.org/packages/18/36/fa2246b9d262549f3d824e095bb963e48c638bbf1a252eea2955a00e3ea6/fedoo-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd9f7d62b652193535d485c64cf40b483ba5b5e7406ab4014508ce052a9d3d4d",
                "md5": "1c8446e8b5930083775c51f5905e00ed",
                "sha256": "3e68b6df4a71362c7a5dd8afb082611f0949cb582d0699f884f55cd0f18d9162"
            },
            "downloads": -1,
            "filename": "fedoo-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "1c8446e8b5930083775c51f5905e00ed",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 10802299,
            "upload_time": "2024-07-25T14:33:41",
            "upload_time_iso_8601": "2024-07-25T14:33:41.041135Z",
            "url": "https://files.pythonhosted.org/packages/bd/9f/7d62b652193535d485c64cf40b483ba5b5e7406ab4014508ce052a9d3d4d/fedoo-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-25 14:33:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "3MAH",
    "github_project": "fedoo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "fedoo"
}
        
Elapsed time: 0.67920s