Manual:Installing: Difference between revisions

From FreeCAD Documentation
No edit summary
(Changes to the installation bit.)
Line 15: Line 15:


<!--T:1-->
<!--T:1-->
FreeCAD uses the [https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License LGPL] license; you may download, install, redistribute and use FreeCAD the way you want, regardless of the type of work you'll do with it (commercial or non-commercial). You are not bound to any clause or restriction, and the files you produce with it are fully yours. The only thing that the license prohibits, really, is to claim that you programmed FreeCAD yourself!
FreeCAD is licensed under the [https://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License LGPL] license, which allows you to download, install, redistribute, and use it for any purpose, commercial or non-commercial, without any restrictions. You retain full ownership of the files you create.


<!--T:2-->
<!--T:2-->
FreeCAD behaves the same on Windows, Mac OS and Linux. However, the way to install it differs slightly depending on your platform. On Windows and Mac, the FreeCAD community provides precompiled packages (installers) ready to download; while on Linux, the source code is made available to Linux distributions maintainers who are then responsible for packaging FreeCAD for their specific distribution. As a result, on Linux, you can usually install FreeCAD right from the software manager application.
FreeCAD operates consistently across Windows, macOS, and Linux, although the installation process varies by platform. For Windows and Mac users, the FreeCAD community offers ready-to-use precompiled installers. On Linux, the source code is provided to distribution maintainers who package the software for their specific systems. Typically, Linux users can install FreeCAD directly through their system’s software manager.


<!--T:3-->
<!--T:3-->
The official FreeCAD download page for Windows and Mac OS is https://github.com/FreeCAD/FreeCAD/releases
The official FreeCAD download page can be found at the [https://www.freecad.org/downloads.php FreeCAD download page]. Additional information about the installation process can be found at the dedicated [https://wiki.freecad.org/Download download wiki].


<!--T:4-->
<!--T:4-->
Line 27: Line 27:


<!--T:5-->
<!--T:5-->
The official releases of FreeCAD, that you can find on the page referenced above and in your distribution's software manager, are stable versions. However, the development of FreeCAD is fast! New features and bug fixes are added almost every single day. Since it is often a long time between stable releases, you might be interested in trying a more bleeding-edge version of FreeCAD. These development versions, or pre-releases, are uploaded from time to time to the [https://github.com/FreeCAD/FreeCAD/releases download page] mentioned above, or, if you are using Ubuntu or Fedora, the FreeCAD community also maintains [https://launchpad.net/~freecad-maintainers/+archive/ubuntu/freecad-daily PPA] (Personal Package Archives) and [https://copr.fedorainfracloud.org/groups/g/freecad/coprs/ copr] 'daily builds' which are regularly updated with the most recent changes.
The official stable releases of FreeCAD are available on the referenced download page and within your distribution's software manager. However, FreeCAD's development pace is brisk, with new features and bug fixes incorporated almost daily. Due to the extended periods between stable releases, you may want to experiment with more current, bleeding-edge versions of FreeCAD. These development versions, or pre-releases, can be found at the same download page. For users on Ubuntu or Fedora, the FreeCAD community also provides [https://launchpad.net/~freecad-maintainers/+archive/ubuntu/freecad-daily PPA] (Personal Package Archives) and [https://copr.fedorainfracloud.org/groups/g/freecad/coprs/ copr] 'daily builds', which are regularly updated with the latest developments.


<!--T:6-->
<!--T:6-->
If you are installing FreeCAD in a virtual machine, please be aware that the performance might be poor (in some cases unusable) due to the limits of [https://en.wikipedia.org/wiki/OpenGL OpenGL] support on most virtual machines.
If you plan to install FreeCAD on a virtual machine, be aware that its performance might be significantly impaired, and perhaps unusable, due to limited OpenGL support in many virtual machines.


=== Installing on Windows === <!--T:7-->
=== Installing on Windows === <!--T:7-->


<!--T:8-->
<!--T:8-->
# Download an installer (.exe) package corresponding to your version of Windows (32bit or 64bit) from the [https://github.com/FreeCAD/FreeCAD/releases download page]. The FreeCAD installers should work on any windows version starting from Windows 7.
# Download an installer (.exe) from the download page. The FreeCAD installers should work on any windows version starting from Windows 7.
# Accept the terms of the LGPL license; this will be one of the few cases where you can really, safely click the "accept" button without reading the text. No hidden clauses: [[Image:Freecad-windows-install-01.jpg|none]]
# Double-click the downloaded installer.
# Accept the terms of the LGPL license, this will be one of the few cases where you can really, safely click the "accept" button without reading the text. No hidden clauses: [[Image:Freecad-windows-install-01.jpg|none]]
# You can leave the default path here, or change if you wish: [[Image:Freecad-windows-install-02.jpg|none]]
# You can leave the default path here, or change if you wish: [[Image:Freecad-windows-install-02.jpg|none]]
# No need to set the PYTHONPATH variable, unless you plan to do some advanced python programming, in which case you probably already know what this is for: [[Image:Freecad-windows-install-03.jpg|none]]
# No need to set the PYTHONPATH variable, unless you plan to do some advanced python programming, in which case you probably already know what this is for: [[Image:Freecad-windows-install-03.jpg|none]]
# During the installation, a couple of additional components, which are bundled inside the installer, will be installed too: [[Image:Freecad-windows-install-04.jpg|none]]
# During the installation, a couple of additional components, which are bundled inside the installer, will be installed too: [[Image:Freecad-windows-install-04.jpg|none]]
# That's it, FreeCAD is installed. You will find it in your start menu. [[Image:Freecad-windows-install-05.jpg|none]]
# That’s it. The installation is now complete and you can start exploring the capabilities of FreeCAD. [[Image:Freecad-windows-install-05.jpg|none]]


<!--T:9-->
<!--T:9-->
Line 47: Line 46:


<!--T:10-->
<!--T:10-->
Packaging FreeCAD and creating an installer takes some time and dedication, so usually development (also called pre-release) versions are provided as .zip (or .7z) archives. These don't need to be installed; just unpack them and launch FreeCAD by double-clicking the FreeCAD.exe file that you will find inside. This also allows you to keep both the stable and "unstable" versions together on the same computer.
Packaging FreeCAD and developing an installer involves a considerable investment of time and effort. As a result, development versions (also referred to as pre-release versions) are typically delivered in the form of .zip or .7z archives located at the [https://www.freecad.org/downloads.php FreeCAD download page]. There's no need for a formal installation process with these files; simply extract the contents and start FreeCAD by double-clicking the FreeCAD.exe file located inside. This approach also enables you to maintain both the stable and the "unstable" versions on the same computer. It’s like having both a dependable daily car and an experimental jet pack in your garage!


=== Installing on Linux === <!--T:11-->
=== Installing on Linux === <!--T:11-->


<!--T:12-->
<!--T:12-->
On most modern Linux distributions (Ubuntu, Fedora, openSUSE, Debian, Mint, Elementary, etc), FreeCAD can be installed with the click of a button, directly from the software management application provided by your distribution (the aspect of it can differ from the images below, each distribution uses its own tool).
For users of modern Linux distributions such as Ubuntu, Fedora, openSUSE, Debian, Mint, and Elementary, installing FreeCAD is as simple as a single click. You can seamlessly install it through the software management tool provided by your distribution, though the appearance of these tools may differ from any illustrative images, since each distribution employs its own distinct application.


<!--T:13-->
<!--T:13-->
Line 62: Line 61:


<!--T:15-->
<!--T:15-->
One of the big joys of using Linux is the multitude of possibilities to tailor your software, so don't restrain yourself. On Ubuntu and derivatives, FreeCAD can also be installed from a [https://launchpad.net/~freecad-maintainers PPA] maintained by the FreeCAD community (it contains both stable and development versions). On Fedora, recent development versions of FreeCAD can be installed from [https://copr.fedorainfracloud.org/groups/g/freecad/coprs/ copr], and because this is open source software, you can also easily [[Compiling|compile FreeCAD yourself]].
One of the great pleasures of using Linux is the vast array of options available for customizing your software experience, so don't hold back. For users of Ubuntu and its derivatives, FreeCAD can be installed from a [https://launchpad.net/~freecad-maintainers PPA] maintained by the FreeCAD community, which includes both stable and development versions. On Fedora, you can access the latest development versions of FreeCAD via [https://copr.fedorainfracloud.org/groups/g/freecad/coprs/ copr]. Additionally, since FreeCAD is open source, you also have the freedom to [[Compiling|compile FreeCAD yourself]].


=== Installing on Mac OS === <!--T:16-->
=== Installing on Mac OS === <!--T:16-->
Line 70: Line 69:


<!--T:18-->
<!--T:18-->
# Download a zipped package corresponding to your version from the [https://github.com/FreeCAD/FreeCAD/releases download page].
# Download a zipped package corresponding to your version.
# Open the Downloads folder, and expand the downloaded zip file: [[Image:Freecad-mac-01.jpg|none]]
# Open the Downloads folder, and expand the downloaded zip file: [[Image:Freecad-mac-01.jpg|none]]
# Drag the FreeCAD application from inside the zip to the Applications folder: [[Image:Freecad-mac-02.jpg|none]]
# Drag the FreeCAD application from inside the zip to the Applications folder: [[Image:Freecad-mac-02.jpg|none]]
Line 79: Line 78:


<!--T:20-->
<!--T:20-->
Hopefully you won't want to uninstall FreeCAD, but it is good to know how. On Windows and Linux, uninstalling FreeCAD is very straightforward. On Windows, use the standard "remove software" option found in the control panel; on Linux, remove it with the same software manager you used to install it. On Mac OS, simply remove it from the Applications folder.
Ideally, you'll never want to part ways with FreeCAD, but should you ever need to uninstall it, rest assured the process is simple. On Windows, use the familiar "remove software" option from the control panel. For Linux users, uninstall it using the same software manager you employed to install it. Mac users have it easiest—just drag FreeCAD from the Applications folder to the trash.





=== Setting basic preferences === <!--T:21-->
=== Setting basic preferences === <!--T:21-->

Revision as of 20:53, 25 May 2024

FreeCAD is licensed under the LGPL license, which allows you to download, install, redistribute, and use it for any purpose, commercial or non-commercial, without any restrictions. You retain full ownership of the files you create.

FreeCAD operates consistently across Windows, macOS, and Linux, although the installation process varies by platform. For Windows and Mac users, the FreeCAD community offers ready-to-use precompiled installers. On Linux, the source code is provided to distribution maintainers who package the software for their specific systems. Typically, Linux users can install FreeCAD directly through their system’s software manager.

The official FreeCAD download page can be found at the FreeCAD download page. Additional information about the installation process can be found at the dedicated download wiki.

FreeCAD versions

The official stable releases of FreeCAD are available on the referenced download page and within your distribution's software manager. However, FreeCAD's development pace is brisk, with new features and bug fixes incorporated almost daily. Due to the extended periods between stable releases, you may want to experiment with more current, bleeding-edge versions of FreeCAD. These development versions, or pre-releases, can be found at the same download page. For users on Ubuntu or Fedora, the FreeCAD community also provides PPA (Personal Package Archives) and copr 'daily builds', which are regularly updated with the latest developments.

If you plan to install FreeCAD on a virtual machine, be aware that its performance might be significantly impaired, and perhaps unusable, due to limited OpenGL support in many virtual machines.

Installing on Windows

  1. Download an installer (.exe) from the download page. The FreeCAD installers should work on any windows version starting from Windows 7.
  2. Accept the terms of the LGPL license; this will be one of the few cases where you can really, safely click the "accept" button without reading the text. No hidden clauses:
  3. You can leave the default path here, or change if you wish:
  4. No need to set the PYTHONPATH variable, unless you plan to do some advanced python programming, in which case you probably already know what this is for:
  5. During the installation, a couple of additional components, which are bundled inside the installer, will be installed too:
  6. That’s it. The installation is now complete and you can start exploring the capabilities of FreeCAD.

Installing a development version

Packaging FreeCAD and developing an installer involves a considerable investment of time and effort. As a result, development versions (also referred to as pre-release versions) are typically delivered in the form of .zip or .7z archives located at the FreeCAD download page. There's no need for a formal installation process with these files; simply extract the contents and start FreeCAD by double-clicking the FreeCAD.exe file located inside. This approach also enables you to maintain both the stable and the "unstable" versions on the same computer. It’s like having both a dependable daily car and an experimental jet pack in your garage!

Installing on Linux

For users of modern Linux distributions such as Ubuntu, Fedora, openSUSE, Debian, Mint, and Elementary, installing FreeCAD is as simple as a single click. You can seamlessly install it through the software management tool provided by your distribution, though the appearance of these tools may differ from any illustrative images, since each distribution employs its own distinct application.

  1. Open the software manager and search for "freecad":
  2. Click the "install" button and that's it, FreeCAD gets installed. Don't forget to rate it afterwards!

Alternative ways

One of the great pleasures of using Linux is the vast array of options available for customizing your software experience, so don't hold back. For users of Ubuntu and its derivatives, FreeCAD can be installed from a PPA maintained by the FreeCAD community, which includes both stable and development versions. On Fedora, you can access the latest development versions of FreeCAD via copr. Additionally, since FreeCAD is open source, you also have the freedom to compile FreeCAD yourself.

Installing on Mac OS

Installing FreeCAD on Mac OSX is nowadays as easy as on other platforms. However, since there are fewer people in the community who own a Mac, the available packages sometimes lag a few versions behind the other platforms.

  1. Download a zipped package corresponding to your version.
  2. Open the Downloads folder, and expand the downloaded zip file:
  3. Drag the FreeCAD application from inside the zip to the Applications folder:
  4. That's it, FreeCAD is installed!

5. If the system prevents FreeCAD from launching due to restricted permissions for applications not coming from the App store, you will need to enable it in the system settings:

Uninstalling

Ideally, you'll never want to part ways with FreeCAD, but should you ever need to uninstall it, rest assured the process is simple. On Windows, use the familiar "remove software" option from the control panel. For Linux users, uninstall it using the same software manager you employed to install it. Mac users have it easiest—just drag FreeCAD from the Applications folder to the trash.



Setting basic preferences

Once FreeCAD is installed, you might want to open it and change some preferences. Preference settings in FreeCAD are located under menu Edit → Preferences. Listed below are some basic settings you may wish to change; you can browse through the preference pages to see if there is anything else you want to change.

  1. Language: (General category, General tab) FreeCAD will automatically pick the language of your operating system, but you might want to change that. FreeCAD is almost fully translated into five or six languages; others are currently only partially translated. You can easily help translating FreeCAD.
  2. Auto-load module: (General category, General tab) Normally, FreeCAD will start by showing you the start page. You can skip this and begin a FreeCAD session directly in the workbench of your choice, listed under Startup, Auto load module after startup. Workbenches will be explained in detail in the next chapter.
  3. Create new document at startup: (General category, Document tab) Combined with the Auto-load module option above, if checked this starts FreeCAD ready for work.
  4. Storage options: (General category, Document tab) As with any complex application, FreeCAD likely contains bugs causing it to crash occasionally. Here you can configure options to help you to recover your work in case of a crash.
  5. Authoring and license: (General category, Document tab) Here you set the values to be used for new files you create. Consider making your files shareable right from the start, by using a friendlier, copyleft license like Creative Commons.
  6. Redirect internal python messages: (General category, Output window tab) These two options are always good to check, as they will cause messages from the internal python interpreter to show up in the Report View when there's a problem running a python script.
  7. Units: (General category, Units tab) Here you can set the default units system you wish to use.
  8. Zoom at cursor: (Display category, 3D tab) If set, zoom operations will be focused at the mouse pointer. If unset, the center of the current view is the zoom focus.
  9. Invert zoom: (Display category, 3D tab) Inverts the direction of zooming relative to mouse movement.

Installing additional content

As the FreeCAD project and its community grows quickly, and also because it is easy to extend, external contributions and side-projects made by community members and other enthusiasts begin to appear everywhere on the internet. Most of these external projects are workbenches or macros, and can be easily installed right from within FreeCAD via the Addon Manager located under menu Tools. The addons manager will allow you to install many interesting components, for example:

  1. A Parts library, which contains all kinds of useful models, or pieces of models, created by FreeCAD users that can be freely used in your projects. The library can be used and accessed right from inside your FreeCAD installation.
  2. Additional workbenches, that extend the functionality of FreeCAD for certain tasks, for example animate parts of your models, or areas, such as sheet metal folding or BIM. Further explanations of each workbench and what tools it contains is given on each addon page, that you can visit by clicking the corresponding link on the addon manager.
  3. A collection of macros, which are also available on the FreeCAD wiki along with documentation about how to use them.

If you are using the Ubuntu operating system, some of the addons above are also available as packages on the FreeCAD addons PPA

Read more