myfempy

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

https://github.com/avgcampos/myfempy

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (20.0%) to scientific vocabulary

Keywords

computational-fluid-dynamics finite-element-method finite-elements fluid-structure-interaction mechanics-of-solids multiphysics numpy python science-research scientific-computing scipy thermomechanical-coupling
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 1
  • Open Issues: 5
  • Releases: 26
Topics
computational-fluid-dynamics finite-element-method finite-elements fluid-structure-interaction mechanics-of-solids multiphysics numpy python science-research scientific-computing scipy thermomechanical-coupling
Created almost 4 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation

README.md

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. The name myfempy is an acronym for MultiphYsics Finite Elements Module to PYthon. You can help us by contributing with a donation on the main project page, send us a email [antonio.garcia&edu.ufpi.br]. 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:

```bash

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.11

Installation prerequisites, required to build myfempy

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

  • Python 3.11.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

```bash

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

goto gmsh PyPi to install the API gmsh/python

  • try

```bash

pip install gmsh

```

or

  • to linux system:

```bash

apt install 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.

```bash

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:

```bash

Antonio Vinicius Garcia Campos. (2022). myfempy (1.5.1). Zenodo. https://doi.org/10.5281/zenodo.6958796

```

  • BibTex:

```bash

@software{antonioviniciusgarciacampos2022_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.


Owner

  • Name: Antonio Vinicius Garcia Campos
  • Login: avgcampos
  • Kind: user
  • Location: Campinas, SP
  • Company: @easycae-3d

Mechanical Engineer. FEA&FEM | Solid Mechanics | Modal Analysis | Python Dev - MSc Solid Mechanics and FEM aplications.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: "Garcia Campos"
    given-names: "Antonio Vinicius"
    email: 3deasycaebr.contato@gmail.com
    orcid: 'https://orcid.org/0000-0003-1678-384X'
title: 'Myfempy is a python package for scientific analysis based on finite element method'
version: v0.8.0
doi: 10.5281/zenodo.6958796
date-released: 2022-08-03
url: 'https://github.com/avgcampos/myfempy'
license: GPL
preferred-citation:
  type: software
  authors:
  - family-names: Garcia Campos
    given-names: Antonio Viniciuss
    email: 3deasycaebr.contato@gmail.com
    orcid: 'https://orcid.org/0000-0003-1678-384X'
  title: 'myfempy'
  month: 8
  year: 2022
  publisher: "Zenodo"
  version: v0.8.0
  doi: "10.5281/zenodo.6958796"
  url: 'https://github.com/avgcampos/myfempy'
  

GitHub Events

Total
  • Create event: 7
  • Release event: 7
  • Issues event: 9
  • Watch event: 2
  • Issue comment event: 38
  • Push event: 12
  • Fork event: 1
Last Year
  • Create event: 7
  • Release event: 7
  • Issues event: 9
  • Watch event: 2
  • Issue comment event: 38
  • Push event: 12
  • Fork event: 1

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 368
  • Total Committers: 2
  • Avg Commits per committer: 184.0
  • Development Distribution Score (DDS): 0.016
Past Year
  • Commits: 118
  • Committers: 1
  • Avg Commits per committer: 118.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Vinicius Campos a****s@g****m 362
Vinicius Campos 5****s 6

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 9
  • Total pull requests: 0
  • Average time to close issues: over 1 year
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.11
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • avgcampos (8)
Pull Request Authors
Top Labels
Issue Labels
documentation (2) good first issue (1) enhancement (1)
Pull Request Labels

Dependencies

setup.py pypi
  • art *
  • colorama *
  • matplotlib *
  • numpy *
  • scipy *
  • vedo *
.github/workflows/build.yml actions
  • SonarSource/sonarcloud-github-action master composite
  • actions/checkout v2 composite
  • actions/upload-artifact v2 composite