Installing additional components/pt: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Docnav
{{Docnav
|[[Installing_on_Mac|Installing on Mac]]
|[[About FreeCAD|About FreeCAD]]
|[[Getting started|Getting started]]
|[[Getting_started|Getting started]]
}}
}}

{{TOCright}}

=Introduction=


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 11: Line 16:
{| align='center' width=50%
{| align='center' width=50%
|align=center|[[Image:Windows.png | alt='Windows' | link= Install on Windows]]
|align=center|[[Image:Windows.png | alt='Windows' | link= Install on Windows]]
|align=center|[[Image:Linux.png | alt='Linux' | link= Install on Unix]]
|align=center|[[Image:Linux.png | alt='Linux' | link= Install on Linux]]
|align=center|[[Image:Mac.png | alt='Mac' | link= Install on Mac]]
|align=center|[[Image:Mac.png | alt='Mac' | link= Install on Mac]]
|-
|-
|align=center|[[Install on Windows/pt|Instalação em Windows]]
|align=center|[[Install on Windows/pt|Instalação em Windows]]
|align=center|[[Install on Unix/pt|Instalação em Linux/Unix]]
|align=center|[[Install on Linux/pt|Instalação em Linux]]
|align=center|[[Install on Mac/pt|Instalação em Mac]]
|align=center|[[Install on Mac/pt|Instalação em Mac]]
|}
|}
</div>
</div>


=Help files=
==Installing additional contents==
The offline documentation is not shipped with all installers, but it is available as a separate package; see [[Installing Helpfile|Installing a helpfile]].


See [[Installing_Helpfile|Installing Helpfile]].
Apart from the default [[workbenches|workbenches]] bundled with FreeCAD, there is a growing collection of useful additional workbenches and modules made by community members available on the web. Several efforts are in progress to gather them and make them available to you in a convenient way. They are listed below.


=External workbenches=
Since these workbenches are not part of the official FreeCAD package and not supported by the core FreeCAD team, you should read the information provided with them, to make sure you know what you are installing. Bug reports and feature requests should be made directly to each addon developer.


Apart from the default [[workbenches|workbenches]] bundled with FreeCAD, there is a large collection of useful [[External_workbenches|external workbenches]] made by community members.
===The FreeCAD-addons repository===


=Third party software=
As of FreeCAD 0.17, the addons can be managed directly from the {{MenuCommand|Tools}} menu, so there is no need to install the macro mentioned here.


FreeCAD supports several third party software packages out of the box. In many cases all you need to do is install the software, and when FreeCAD is restarted it will automatically find and be able to use it. This section aims to provide a list of such software packages, together with some information about where they are used in FreeCAD and where they can be downloaded.
This is a gathering of useful workbenches, using the git submodules system, which allows keeping constantly updated contents. The FreeCAD-addons repository can be found at https://github.com/FreeCAD/FreeCAD-addons. This repository features an installer macro that can be launched from inside FreeCAD that will list, download, and install any of the addons automatically.


==Support==
With FreeCAD 0.17 and higher install use the [[Addon Manager|Addon Manager]].


===GitPython===
<div class="mw-collapsible mw-collapsed toccolours">
<small>*With FreeCAD 0.16 and older versions, install the addon installer macro:
</small><div class="mw-collapsible-content">
# Right-click on [https://github.com/FreeCAD/FreeCAD-addons/raw/master/addons_installer.FCMacro addons_installer.FCMacro] and choose '''Save as...'''
# Place the downloaded macro in your '''FreeCAD Macros folder'''. The FreeCAD Macros folder location is indicated in menu {{MenuCommand|Macros → Macros → User macros location}}:
[[Image:Macro_installer_01.jpg]]
# Restart FreeCAD. The addons installer will now be listed in menu {{MenuCommand|Macro → Macros}} and can be launched by selecting it then clicking the {{Button|Execute}} button:
[[Image:Macro_installer_02.jpg]]
</div></div>


[https://github.com/gitpython-developers/GitPython GitPython] is a library to interact with Git repositories. The [[Std_AddonMgr|Addon Manager]] can use this library. GitPython is included in the FreeCAD installers for Windows and Mac.
===<s>The pluginloader addon</s>===


===GraphViz===
<s>The plugin loader is a much more elaborate way to install and manage additional content for FreeCAD. Install it with the method above, or following the instructions on the [https://github.com/microelly2/freecad-pluginloader pluginloader page].</s>


[https://www.graphviz.org GraphViz] is an open source graph visualization software. It is used by the [[Std_DependencyGraph|Std DependencyGraph]] tool.
The pluginloader addon has been superceded by the [[Addon Manager|Addon Manager]].


===Manual install===
===OpenCAMLib===


[http://www.anderswallin.net/CAM OpenCAMLib] is an open source library of computer aided manufacturing (CAM) algorithms. It is used in the [[Path_Workbench|Path Workbench]]. See the [[OpenCamLib|OpenCamLib]] page for installation instructions.
External workbenches, when they are fully programmed in Python (which is the majority) can be easily installed manually, simply by downloading them (clicking the {{Button|Clone or download}} or {{Button|Download ZIP}} buttons on GitHub), and placing them in your user's {{FileName|FreeCAD/Mod}} folder (or in the {{FileName|Macros}} folder if they are [[macros|macros]]). Refer to the instructions on each addon page for complete information.


===OpenSCAD===
===Notes for users with 32-bit system and FreeCAD 0.16.6706===
After attempts to install, the additional workbenches may not be available. In this case
* hold the report panel open while starting FreeCAD, and read the error
* see this forum thread: [http://forum.freecadweb.org/viewtopic.php?t=12839#p102933 (Solved)Assembly2 in Version: 0.16.5602 (Git)]


[https://www.openscad.org OpenSCAD] is a solid 3D modeller. The [[OpenSCAD_Workbench|OpenSCAD Workbench]] depends on this software and the [[Mesh_Workbench|Mesh Workbench]] uses it for its Boolean tools. It is also required for the import of SCAD files with the [[Std_Import|Std Import]] tool.
==External software supported by FreeCAD==


==File formats==
FreeCAD supports a whole lot of external software packages out of the box. This means, you just need to install the software and it will be automatically available, the next time you start it. There's no need to recompile it. This section aims to provide a list of all such software packages, together with some information of where it's used in FreeCAD and where you can grab them.


All software in this section will be used by the [[Std_Import|Std Import]] or [[Std_Export|Std Export]] tools.
=== Support ===


====GraphViz====
===CADExchanger===


[https://cadexchanger.com CADExchanger] is a commercial application for exchanging various CAD file formats. There is an [https://github.com/yorikvanhavre/CADExchanger external workbench] to use this application in FreeCAD.
GraphViz is an open source graph visualization software. In FreeCAD it is used to generate dependency graphs through {{MenuCommand|Tools → [[Std_DependencyGraph|Dependency Graph]]}}. Its homepage is at https://www.graphviz.org


====OpenCAMLib====
===DXF Importer===


FreeCAD has a native importer and exporter for DXF files, programmed in C++. Currently they do not implement all features of the DXF format. For those features the legacy Python importer and exporter are still available. These require the [https://github.com/yorikvanhavre/Draft-dxf-importer Draft-dxf-importer] Python library. See the [[FreeCAD_and_DXF_Import|FreeCAD and DXF Import]] page for more information.
[[OpenCamLib|OpenCAMLib]] is an open source library of computer aided manufacturing (CAM) algorithms and used in the [[Path_Workbench|Path Workbench]]. See [[OpenCamLib|its page]] for installation instructions.


====OpenSCAD====
===DWG converters===


FreeCAD cannot directly read and write DWG files. To convert DXF files to DWG files, and vice-versa, FreeCAD relies on external converters. There is built-in support for the following DWG converters:
OpenSCAD is solid 3D modeller based on the [[constructive_solid_geometry|constructive solid geometry]] (CSG) paradigm, where the model is created through a script. It can not handle meshes, but operates exclusively on solid geometry. FreeCAD can import and export files created from OpenSCAD through the [[Std_Import|Std Import]] and [[Std_Export|Std Export]] tools by the selecting the {{MenuCommand|OpenSCAD CSG format}} or the {{MenuCommand|OpenSCAD format}} file types. You can get OpenSCAD from https://www.openscad.org.
* [https://www.gnu.org/software/libredwg LibreDWG] (open-source, lacks support for some DWG entities).
* [https://www.opendesign.com/guestfiles/oda_file_converter ODA File Converter] (free, but not open-source).
* [https://qcad.org/en/qcad-command-line-tools#dwg2dwg QCAD pro] (commercial). {{Version|0.20}}


See [[Import_Export_Preferences#DWG|Import Export Preferences]] and [[FreeCAD_and_DWG_Import|FreeCAD and DWG Import]] for more information.
====GitPython====


===IfcOpenShell===
GitPython is a library to interact with Git repositories. The [[Std_AddonMgr|Addon Manager]] can use this library to import addons from a Git repository. The project is hosted on GitHub at https://github.com/gitpython-developers/GitPython.


[http://ifcopenshell.org IfcOpenShell] is a library for working with the Industry Foundation Classes (IFC) file format used in architectural design. The library is also used by the [[Arch_IfcExplorer|Arch IfcExplorer]] ({{VersionMinus|0.18}}) and [[BIM_IfcExplorer|BIM IfcExplorer]] tools. IfcOpenShell is included in the FreeCAD installers for Windows and Mac.
=== Finite element ===


====CalculiX====
===IfcJson===


[https://github.com/buildingSMART/ifcJSON IfcJson] is a library required for exporting to the IFCJSON file format. IFCJSON is a new IFC format that is not yet supported by many applications.
CalculiX is a suite of two finite element packages:
* CalculiX CrunchiX, or {{incode|calculix-ccx}}, is a FEM solver.
* CalculiX GraphiX, or {{incode|calculix-cgx}}, is a GUI frontend to display the results of the solver.


===Pycollada===
Only the solver is supported by FreeCAD. It can be accessed from the [[FEM Workbench|FEM Workbench]] through {{MenuCommand|Solve → [[FEM_SolverCalculiX|Solver CalculiX]]}}. There's a standard and experimental solver supported by FreeCAD. CalculiX can be downloaded from http://calculix.de


[https://github.com/pycollada/pycollada/releases Pycollada], also known as python-collada, is a Python library to read and write Collada (DAE) files. Pycollada is included in the FreeCAD installers for Windows and Mac.
====Gmsh====


==Rendering==
Gmsh is an automatic finite element mesh generator. It can be used in FreeCAD from the [[FEM_Module|FEM workbench]] through {{MenuCommand|Mesh → [[FEM_MeshGmshFromShape|FEM mesh from shape by Gmsh]]}}. The homepage of Gmsh is at http://www.geuz.org/gmsh


====Elmer====
===LuxCoreRender===
[https://www.luxcorerender.org LuxCoreRender] is a render engine, reboot of the [[LuxRender|LuxRender]] project. Officially it is not supported by the [[Raytracing_Workbench|Raytracing Workbench]], but it might be worth to give it a try. It is officially supported by the new [https://github.com/FreeCAD/FreeCAD-render Render Workbench], intended as a future replacement of the Raytracing Workbench. See the [[LuxCoreRender|LuxCoreRender]] page for more information and installation instructions.


===LuxRender===
Elmer is a multi-physics simulation software, which was open sourced in 2005. In FreeCAD its Grid and Solver modules can be used by the [[FEM Workbench|FEM Workbench]] through {{MenuCommand|Solve → [[FEM_SolverElmer|Solver Elmer]]}}. The project's homepage is at https://www.elmerfem.org and it can be downloaded from GitHub at https://github.com/ElmerCSC/elmerfem/releases.
[https://luxcorerender.org/history/ LuxRender] is one of the two render engines supported by the [[Raytracing_Workbench|Raytracing Workbench]]. In 2013 the project has been rebooted becoming [[LuxCoreRender]], with a major code rewriting and compatibility breaking changes. Officially the Raytracing Workbench only supports the abandoned [[LuxRender|LuxRender]] (latest version is 1.6, 2017-12-28), while the new [https://github.com/FreeCAD/FreeCAD-render Render Workbench] (intended as a future replacement of the Raytracing Workbench) supports instead LuxCoreRender and has dropped the support for LuxRender. Anyway, even if officially not supported, [[LuxCoreRender|LuxCoreRender]] may work with the Raytracing Workbench, it might be worth to give it a try. See the [[LuxRender|LuxRender]] page for more information and installation instructions, and the [[LuxCoreRender|LuxCoreRender]] if you want to try a more modern software.


====FEniCS====
===POV-Ray===


[https://www.povray.org POV-Ray] is a well-known ray-tracer which can render photo-realistic images. It is one of two render engines currently supported by the [[Raytracing_Workbench|Raytracing Workbench]]. See the [[POV-Ray|POV-Ray]] page for more information and installation instructions.
FEniCS is a computing platform to solve partial differential equations (PDEs), which are widely used when solving FEM problems. As such it can be used by the [[FEM_Module|FEM workbench]]. FreeCAD can import and export FEniCS meshes through [[Std_Import|Std Import]] and [[Std_Export|Std Export]] by selecting the {{MenuCommand|FEM mesh fenics}} file format. The homepage of FEniCS is at https://fenicsproject.org.


====Z88====
==Finite element==


===CalculiX===
Z88 is another FEM program, containing a mesher, solver and converters, which can be used by FreeCAD's [[FEM_Module|FEM workbench]]. It can be accessed through {{MenuCommand|Solve → [[FEM_SolveZ88|Solver Z88]]}}. Z88 distributes several packages, which all freely available, but are closed source. The Z88OS however, published under an open source license, is what is needed by FreeCAD. The homepage is at https://en.z88.de/. Z88OS is also hosted on GitHub at https://github.com/LSCAD/Z88OS, if you want to compile it yourself.


[http://calculix.de CalculiX] is a suite of two finite element packages: CalculiX CrunchiX, a FEM solver, and
====OpenFOAM====
CalculiX GraphiX, a GUI frontend. Only the solver is supported by FreeCAD. It is used by the [[FEM_SolverCalculiX|Solver CalculiX]] tool.


===Gmsh===
OpenFOAM is a large collection of libraries for computational fluid dynamics (CFD) simulations. OpenFOAM can be used by [[external_workbenches|external workbenches]] that build on top of FreeCAD to work as a preprocessor. The project resides at https://openfoam.org.


[http://gmsh.info Gmsh] is an automatic finite element mesh generator. it is used by the [[FEM_MeshGmshFromShape|FEM MeshGmshFromShape]] and [[Mesh_FromPartShape|Mesh FromPartShape]] tools.
=== File formats ===


====CAD Exchanger====
===Elmer===


[https://www.csc.fi/web/elmer Elmer] is a multi-physics simulation software, which was open sourced in 2005. In FreeCAD its Grid and Solver modules are used by the [[FEM_SolverElmer|FEM SolverElmer]] tool.
A proprietary, closed source application for exchanging various file formats used in CAD. You can use it to convert proprietary, closed formats into a format which is accessible by FreeCAD. The homepage is at https://cadexchanger.com/ where you can download an evaluation version or purchase a license for the application.


====DXF Importer====
===FEniCS===


[https://fenicsproject.org FEniCS] is a computing platform to solve partial differential equations (PDEs), which are widely used when solving FEM problems. It is used by the [[FEM_Workbench|FEM workbench]]
FreeCAD has a native importer and exporter for DXF files, programmed in C++. Currently this importer does not implement all features of the DXF format. If you rely on a not yet implemented feature, you enable an older python based importer/exporter through {{MenuCommand|Edit → Preferences → Import-Export}} by activating the {{MenuCommand|Use legacy python importer}} option. You can then choose to let FreeCAD automatically download the needed files or you can grab them from https://github.com/yorikvanhavre/Draft-dxf-importer. The chosen importer and exporter is used by [[Std_Import|Std Import]] and [[Std_Export|Std Export]] and choosing the {{MenuCommand|AutoDesk DXF 2D}} file format.


====ODA File Converter====
===Z88===


[https://en.z88.de Z88] is another FEM program, containing a mesher, a solver and converters. It is used by the [[FEM_SolverZ88|FEM SolverZ88]] tool. FreeCAD requires the open source Z88OS package.
The ODA file converter is a proprietary, closed source, binary and freely available application to import and export DWG and DXF file formats. In FreeCAD it can be used by [[Std_Import|Std Import]] and [[Std_Export|Std Export]] when you select the {{MenuCommand|AutoDesk DWG 2D}} file type. It can be downloaded from https://www.opendesign.com/guestfiles/oda_file_converter.


====ifcOpenShell====
===OpenFOAM===


[https://openfoam.org OpenFOAM] is a large collection of libraries for computational fluid dynamics (CFD) simulations. OpenFOAM is used by the [[Cfd_Workbench|Cfd]] and [https://github.com/jaheyns/CfdOF CfdOF] [[external_workbenches|external workbenches]].
IfcOpenShell is a library for working with the Industry Foundation Classes (IFC) file format used in architectural design. It can be accessed from the [[Arch Workbench|Arch Workbench]] through {{MenuCommand|Arch → Utilities → Ifc Explorer}}. It's homepage is at http://ifcopenshell.org.


=Related pages=
====pycollada====


* [[Import_Export|Import Export]]
Pycollada, also known as {{incode|python-collada}}, is a Python library to read and write COLLADA documents, a standard for exchanging 3D scenes and elements. If it is installed you can import and export scenes to and from COLLADA files through [[Std_Import|Std Import]] and [[Std_Export|Std Export]] by selecting the COLLADA file type. The project is hosted in GitHub at https://pycollada.github.io/ and you can download the releases at https://github.com/pycollada/pycollada/releases/.
* [[Import_Export_Preferences|Import Export Preferences]]
* [[Third Party Libraries|Third Party Libraries]]


=== Rendering ===

====POVRay====

POVRay is a well-known raytracer which can render photorealistic images. It is one of two raytracers currently supported by FreeCAD in the [[Raytracing Workbench|Raytracing Workbench]]. You can download POVRay from https://www.povray.org.

====LuxCoreRender====

LuxCoreRender, also known as LuxRender, is one of two currently supported render engines in FreeCAD. It is used through the workflow on the [[Raytracing Workbench|Raytracing Workbench]]. Currently only the old and abandoned LuxRender-1.x is supported by FreeCAD. Downloads for LuxRender-1.6 can be grabbed from the LuxCoreRender GitHub release page at https://github.com/LuxCoreRender/LuxCore/releases. The homepage for the current LuxCoreRender project is at https://www.luxcorerender.org.

==Related Pages==
* [[Third Party Libraries|Third Party Libraries]]


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">

Revision as of 20:48, 11 June 2022

Introduction

Escolha o seu sistema operativo

O FreeCAD é um software verdadeiramente multi-plataforma, desenvolvido usando a conhecida arquitetura Qt. Isso significa que o FreeCAD funciona e tem o mesmo aspeto no Windows, Linux e Mac. No entanto, o procedimento de instalação é um pouco diferente para cada sistema operativo. Escolha o seu sistema operativo em baixo para mais detalhes sobre a instalação do FreeCAD.

'Windows' 'Linux' 'Mac'
Instalação em Windows Instalação em Linux Instalação em Mac

Help files

See Installing Helpfile.

External workbenches

Apart from the default workbenches bundled with FreeCAD, there is a large collection of useful external workbenches made by community members.

Third party software

FreeCAD supports several third party software packages out of the box. In many cases all you need to do is install the software, and when FreeCAD is restarted it will automatically find and be able to use it. This section aims to provide a list of such software packages, together with some information about where they are used in FreeCAD and where they can be downloaded.

Support

GitPython

GitPython is a library to interact with Git repositories. The Addon Manager can use this library. GitPython is included in the FreeCAD installers for Windows and Mac.

GraphViz

GraphViz is an open source graph visualization software. It is used by the Std DependencyGraph tool.

OpenCAMLib

OpenCAMLib is an open source library of computer aided manufacturing (CAM) algorithms. It is used in the Path Workbench. See the OpenCamLib page for installation instructions.

OpenSCAD

OpenSCAD is a solid 3D modeller. The OpenSCAD Workbench depends on this software and the Mesh Workbench uses it for its Boolean tools. It is also required for the import of SCAD files with the Std Import tool.

File formats

All software in this section will be used by the Std Import or Std Export tools.

CADExchanger

CADExchanger is a commercial application for exchanging various CAD file formats. There is an external workbench to use this application in FreeCAD.

DXF Importer

FreeCAD has a native importer and exporter for DXF files, programmed in C++. Currently they do not implement all features of the DXF format. For those features the legacy Python importer and exporter are still available. These require the Draft-dxf-importer Python library. See the FreeCAD and DXF Import page for more information.

DWG converters

FreeCAD cannot directly read and write DWG files. To convert DXF files to DWG files, and vice-versa, FreeCAD relies on external converters. There is built-in support for the following DWG converters:

See Import Export Preferences and FreeCAD and DWG Import for more information.

IfcOpenShell

IfcOpenShell is a library for working with the Industry Foundation Classes (IFC) file format used in architectural design. The library is also used by the Arch IfcExplorer (version 0.18 and below) and BIM IfcExplorer tools. IfcOpenShell is included in the FreeCAD installers for Windows and Mac.

IfcJson

IfcJson is a library required for exporting to the IFCJSON file format. IFCJSON is a new IFC format that is not yet supported by many applications.

Pycollada

Pycollada, also known as python-collada, is a Python library to read and write Collada (DAE) files. Pycollada is included in the FreeCAD installers for Windows and Mac.

Rendering

LuxCoreRender

LuxCoreRender is a render engine, reboot of the LuxRender project. Officially it is not supported by the Raytracing Workbench, but it might be worth to give it a try. It is officially supported by the new Render Workbench, intended as a future replacement of the Raytracing Workbench. See the LuxCoreRender page for more information and installation instructions.

LuxRender

LuxRender is one of the two render engines supported by the Raytracing Workbench. In 2013 the project has been rebooted becoming LuxCoreRender, with a major code rewriting and compatibility breaking changes. Officially the Raytracing Workbench only supports the abandoned LuxRender (latest version is 1.6, 2017-12-28), while the new Render Workbench (intended as a future replacement of the Raytracing Workbench) supports instead LuxCoreRender and has dropped the support for LuxRender. Anyway, even if officially not supported, LuxCoreRender may work with the Raytracing Workbench, it might be worth to give it a try. See the LuxRender page for more information and installation instructions, and the LuxCoreRender if you want to try a more modern software.

POV-Ray

POV-Ray is a well-known ray-tracer which can render photo-realistic images. It is one of two render engines currently supported by the Raytracing Workbench. See the POV-Ray page for more information and installation instructions.

Finite element

CalculiX

CalculiX is a suite of two finite element packages: CalculiX CrunchiX, a FEM solver, and CalculiX GraphiX, a GUI frontend. Only the solver is supported by FreeCAD. It is used by the Solver CalculiX tool.

Gmsh

Gmsh is an automatic finite element mesh generator. it is used by the FEM MeshGmshFromShape and Mesh FromPartShape tools.

Elmer

Elmer is a multi-physics simulation software, which was open sourced in 2005. In FreeCAD its Grid and Solver modules are used by the FEM SolverElmer tool.

FEniCS

FEniCS is a computing platform to solve partial differential equations (PDEs), which are widely used when solving FEM problems. It is used by the FEM workbench

Z88

Z88 is another FEM program, containing a mesher, a solver and converters. It is used by the FEM SolverZ88 tool. FreeCAD requires the open source Z88OS package.

OpenFOAM

OpenFOAM is a large collection of libraries for computational fluid dynamics (CFD) simulations. OpenFOAM is used by the Cfd and CfdOF external workbenches.

Related pages


About FreeCAD/pt
Getting started/pt