README
MaxFEM is a free software for numerical simulation in electromagnetism.
Please open help/b-User Guide/index.html for more information.
Prerequities
MaxFEM requires Python 3 with packages wxPython, vtk and paramiko.
Installation
We recommend to install the binaries.
Binaries for Windows
Download the binaries for Windows.
Building from source
Only if you want to build MaxFEM from source, you will need gfortran and make:
- In Windows, both applications are included in the official MinGW build.
- In Debian-based Linux distributions, they can be found in the official repositories.
Building from source in Windows
- In the Command Prompt, go to the MaxFEM installation folder, subfolder code, and run
make -f Makefile.windows.
- To remove all files obtained from the previous compilation, run
make -f Makefile.windows clean.
Building from source in Linux
- In a terminal, go to the MaxFEM installation folder, subfolder code, and run
make.
- To remove all files obtained from the previous compilation, run
make clean.
Updating MaxFEM
If you are updating MaxFEM, you must reset the Materials database:
- Click on menu Project - Configuration and select Reset.
- Click on manu Materials database and select Reset.
If you want to keep the materials you defined in the old version:
- Save the file materials.xml located in the HOME MaxFEM folder (see
menu Help - User guide - Graphical Interface - Solvers compilation -
Folder location).
- Reset the materials database as previously explained.
- Manually merge your materials.xml with the new one created in the HOME MaxFEM
folder.
Usage
- Go to the MaxFEM installation folder, subfolder code, and execute MaxFEM.py.
- To explore some examples, first choose an application in the menu Applications and then a sample data in the menu Sample data. Please go to menu Help - User guide - Applications for a description of those examples.
Testing
This code has been tested in the following platforms:
- Windows 10 with Python 3.8, wxPython 4.1, vtk 9.0 and paramiko 2.7. It was built with gfortran 5.3.
Known issues
- If you install Python packages using
pip install as non-root user, you may need to include the user site-packages directory in the user environment variable Path. See more inforation here.