myfempy

Welcome to myfempy’s online documentation

Under Development

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

logo2

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

[TOC]

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. The name myfempy is an acronym for MultiphYsics Finite Elements Module to PYthon. You can help us by contributing with the main project, send us a mensage Github Discussions. If you use myfempy in your research, the developers would be grateful if you could cite in your work.

sim

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 folder, open a terminal and enter with the command:
>> python -m pip install --upgrade pip

>> pip install .

or

>> python -m pip install --upgrade build

>> python -m build

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 and Windows, MacOS (has not been tested), and requires Python 3 to running.

Installation prerequisites, required to build myfempy

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

Basic python packages required for using myfempy

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

try

>> pip install numpy, cython, scipy, vedo

Others prerequisites

try

>> pip install --upgrade gmsh

Tutorial

An User’s Guide is available here.

Many Examples are available here.

Documentation

The myfempy’s web documents can be found here. The myfempy is documented using the Mkdocs under docs folder.

Releases/ Versions

The changelog 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:

Campos, A. V. G. (2022). myfempy. Zenodo. https://doi.org/10.5281/zenodo.15756128
@software{campos_2022_15756128,
  author       = {Campos, Antonio Vinicius Garcia},
  title        = {myfempy},
  month        = jul,
  year         = 2022,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.15756128},
  url          = {https://doi.org/10.5281/zenodo.15756128},
}

References