femder 0.2.0

A simple acoustic FEM package

Read in other languages: en-US, pt-BR

femder

A Finite Element Method (FEM) code for acoustics written for the undergraduate course "Métodos Numéricos em Acústica e Vibrações", ministered by Dr. Paulo Mareze.

Acknowledgement

Original author: Luiz Augusto T. Ferraz Alvim
Original co-author: Dr. Paulo Mareze

This repository was initially a fork from gutoalvim/femder, but it was detached. It shares its codebase from the parent first commit until gutoalvim/femder@16a7231. From jvcarli/femder@a447e21 onwards they diverge.

Installation

Prerequisites:

• Python >= 3.9, < 3.12

NOTE: If you're a beginner at programming we strongly recommend that you follow the conda installation guide below and download Anaconda Distribution - it includes Python, NumPy, many other commonly used packages for scientific computing and conda - a package manager that makes it easier to install and manage other packages you may need.

Follow the instructions bellow:

For conda - a package manager that comes with Anaconda Distribution, Miniconda and Miniforge (click to expand):

• You'll need a shell with conda in its PATH.

  If you're using Windows and have installed Anaconda Distribution, Miniconda, or Miniforge, you'll have access to the Anaconda Prompt, Anaconda Prompt (miniconda3), or Miniforge Prompt, respectively. Search for them under Windows start menu.

• Create and activate your conda environment:

  Creating a new conda environment for each project you work on is considered a best practice, ensuring better management and isolation of dependencies and promoting a cleaner development workflow.

  You MUST use Python >= 3.9, < 3.12.

  conda create -n myenv python=3.9
  conda activate myenv
  

• Install femder using pip:

  pip install femder
  

For pip - a package manager that comes with Python (click to expand):

• Optional step (recommended) - consider using a virtual environment:

  Creating a new virtual environment for each project you work on is considered a best practice, ensuring better management and isolation of dependencies and promoting a cleaner development workflow.

  • Create your virtual environment as usual:

    python -m venv venv
    

  • Activate the virtual environment:

    • If you use Windows:

      .\venv\Scripts\activate
      

    • If you use macOS or a Linux distribution:

      source venv/bin/activate
      

• Install femder using pip:

  pip install femder
  

Examples

For instructions on running the examples, please refer to the README file in the examples directory.

Contributing

Thank you for considering contributing to femder! You can contribute as a user or as developer, please read our contribution guide.

Remember, no contribution is too small! Every line of code, every documentation update, and every bug report helps making the library better for everyone.

---

Have fun doing acoustics! If you experience any bugs or problems, have any suggestions or ideas, please open an issue.

Special thanks to Luiz Augusto Alvim, Dr. Paulo Mareze, Dr. Eric Brandão, Alexandre Piccini and Rinaldi Petrolli.