Onboarding FEM Devs: Difference between revisions
m (→Related: added bugtracker subsection link) |
|||
Line 31: | Line 31: | ||
The FEM code lives in {{incode|src/Mod/Fem}} |
The FEM code lives in {{incode|src/Mod/Fem}} |
||
* {{incode|App/}} console-mode application, defines basic structures and base classes for document objects, that are used by modules to build their own. |
* {{incode|App/}} <small>console-mode application, defines basic structures and base classes for document objects, that are used by modules to build their own.</small> |
||
* {{incode|Gui/}} GUI-mode application, defines the [[3D view]], |
* {{incode|Gui/}} <small>GUI-mode application, defines the [[3D view]], tools/functions used by workbench to interact with UI and 3D view, defines base classes for [[view provider|view providers]].</small> |
||
* {{incode|femcommands/}} |
* {{incode|femcommands/}} |
||
* {{incode|fem.dox}} |
* {{incode|fem.dox}} |
Revision as of 22:40, 26 July 2021
Description
This page will orient new developers on how to setup their development environments in order to hack on the FEM workbench.
Setting up a Dev Environment
TBD
Prerequisites
Compiling via Source
TBD
Compiling via Docker
TBD
Source Code Management
Keeping FreeCAD up-to-date is documented in Source code management page. Along with useful git
tips.
FEM Code Infrastructure
The FEM code lives in src/Mod/Fem
App/
console-mode application, defines basic structures and base classes for document objects, that are used by modules to build their own.Gui/
GUI-mode application, defines the 3D view, tools/functions used by workbench to interact with UI and 3D view, defines base classes for view providers.femcommands/
fem.dox
femexamples/
femguiobjects/
femguiutils/
feminout/
femmesh/
femobjects/
femresult/
femsolver/
femtaskpanels/
femtest/
femtools/
femviewprovider/
InitGui.py
Init.py
ObjectsFem.py
TestFemApp.py
TestFemGui.py
Coding Conventions
Please see coding_conventions.md file on the FreeCAD repository.