Skip to content

Myfempy is a python package based on finite element method to multiphysics analysis.

License

Notifications You must be signed in to change notification settings

avgcampos/myfempy

Repository files navigation

Under Development

The myfempy project is under development, updates and code modifications may occur in future versions without prior notice from the developers.

Welcome to myfempy's project

myfempy_logo

Copyright © Antonio Vinicius G. Campos 2022. Processo INPI BR512022001484-0

Python Versions Documentation Status PyPI conda DOI Quality Gate Status ![Downloads] lics Code style: black


About

myfempy is a python package based on finite element method to multiphysics analysis. The code is open source and intended for educational and scientific purposes only, not recommended to commercial use. You can help us by contributing with a donation on the main project page, send us a email [3deasycaebr.contato@gmail.com]. If you use myfempy in your research, the developers would be grateful if you could cite in your work.

Installation

To install myfempy manually in your directory, following the steps

  1. Clone/ Download the main code [latest version] from github/myfempy/main

  2. Unzip the pack in your preferred location

  3. In the myfempy-main folder, open a terminal and enter with the command:

>> python -m pip install --upgrade pip

>> pip install .

Note: is recommend to create a virtual environment previously the installation of myfempy and dependencies packs. You can use the virtualenv or conda environments

Dependencies

Myfempy can be used in systems based on Linux, MacOS and Windows. Myfempy requires Python 3.

Installation prerequisites, required to build myfempy

You can use either of two python development environments to run myfempy

  • Python 3.x - Python is a programming language that lets you work quickly and integrate systems more effectively.
  • Anaconda - Anaconda offers the easiest way to perform Python/R data science and machine learning on a single machine.

Python packages required for using myfempy

The following python packages are required to run myfempy. Before to install myfempy-main, install this packages. Check if they are already installed on your machine

  • numpy - The fundamental package for scientific computing with Python

  • scipy - Fundamental algorithms for scientific computing in Python

  • cython - Cython is a language that makes writing C extensions for Python as easy as Python itself

  • vtk(optional) - VTK is an open-source toolkit for 3D computer graphics, image processing, and visualization

  • vedo - A python module for scientific analysis and visualization of эd objects

  • try

>> pip install numpy

Outhers prerequisites

  • gmsh/External Generator Mesh - Gmsh is an open source 3D finite element mesh generator with a built-in CAD engine and post-processor. Notes: 1 - Gmsh is NOT part of myfempy projects; 2 - Is Needed install Gmsh manually

  • try

>> pip install --upgrade gmsh

Tutorial

A Basic Tutorial is available here.

Many Examples are available here.

Documentation

The myfempy is documented using Mkdocs under docs/. The myfempy's documents versions can be found in html, pdf or epub.

The Web Documentation is available on Read the Docs.

The User's Manual(pdf) is available on manual_myfempy.

To compile the documentation use mkdocs in the \docs folder.

>> make doc

This command generates .html files

Release

The all release versions is available here

License

myfempy is published under the GPLv3 license. See the myfempy/LICENSE.

Citing

Have you found this software useful for your research? Star the project and cite it as:

  • APA:
Antonio Vinicius Garcia Campos. (2022). myfempy (1.5.1). Zenodo. https://doi.org/10.5281/zenodo.6958796
  • BibTex:
@software{antonio_vinicius_garcia_campos_2022_6958796,
author       = {Antonio Vinicius Garcia Campos},
title        = {myfempy},
month        = aug,
year         = 2022,
publisher    = {Zenodo},
version      = {1.5.1},
doi          = {10.5281/zenodo.6958796},
url          = {https://doi.org/10.5281/zenodo.6958796}
}

References

  • Myfempy - A python package for scientific analysis based on finite element method.

  • FEM - The finite element method (FEM) is a popular method for numerically solving differential equations arising in engineering and mathematical modeling.

  • Solid Mechanics - Solid mechanics, also known as mechanics of solids, is the branch of continuum mechanics that studies the behavior of solid materials, especially their motion and deformation under the action of forces, temperature changes, phase changes, and other external or internal agents.

  • PDE - In mathematics, a partial differential equation (PDE) is an equation which imposes relations between the various partial derivatives of a multivariable function.