OpenCamLib: Difference between revisions

From FreeCAD Documentation
m (clarify when it is required)
(copy content from Path_Surface)
Line 1: Line 1:


OpenCamLib is an open source library aiming to provide computer aided manufacturing (CAM) algorithms used in the experimental 3D Surface Path Workbench operation.
OpenCamLib (OCL) is an open source library aiming to provide computer aided manufacturing (CAM) algorithms. FreeCAD uses OCL in the experimental [[Path_Surface|3D surface]] path operations and other experimental features.


==Installing==

=== Windows ===
# Obtain the Python version of OpenCamLib (OCL).
#* Build from [https://github.com/aewallin/opencamlib source] using the Python version used by your FreeCAD version. Peter Lama's [https://github.com/peterlama/opencamlib fork of the same] source has project files for a MSVC build.
#* Download the Python 2.7 [https://github.com/sgrogan/opencamlib/releases binary] by SGrogan on GitHub.
#* Download the Python 3.6 binary. (Currently no link)
# Navigate to your OCL build ''or'' binary folder
# Copy the '''ocl.pyd''' library file
# Proceed with one of the following four(4) options:
#* Navigate to your '''FreeCAD\lib''' folder, and paste the '''ocl.pyd''' file there. {{ColoredText||red|(''This is the preferred option.'')}}
#* Navigate to your '''FreeCAD\bin''' folder, and paste the '''ocl.pyd''' file there.
#* Navigate to your '''FreeCAD\Mod''' folder. Create a new folder, '''OCL'''. Enter the '''OCL''' folder and paste the '''ocl.pyd''' file.
#* Navigate to your '''%USERPROFILE%\AppData\Roaming\FreeCAD''' folder. Create a new folder, '''Mod'''. Enter the '''Mod''' folder. Create a new '''OCL''' folder. Enter the '''OCL''' folder and paste the '''ocl.pyd''' file. {{ColoredText||red|(''This is the least preferred option.'')}}
# Restart FreeCAD
# Verify proper installation
## Click '''View''' → '''Panels''' → '''Python console'''.
## Type "'''import ocl'''" into the Python console and press the '''enter''' key.
## If no error appears, you have correctly installed OCL
##* If you receive an error:
##** Check the placement and name of the '''ocl.pyd''' file as instructed above
##** Verify the correct architecture type of the OCL library you installed - x86 or x64
##** Verify the Python version used to build the OCL library is the same as that of your FreeCAD software - 2.7 or 3.6 currently

=== Linux ===


The repository is [https://github.com/aewallin/opencamlib here] and contains basic installation instructions.
The repository is [https://github.com/aewallin/opencamlib here] and contains basic installation instructions.
Line 13: Line 40:
sudo apt-get install texlive-full
sudo apt-get install texlive-full


=== Mac ===
(No entry)



== More help ==
In case you run into difficulties, you may find additional help at these forum posts:
In case you run into difficulties, you may find additional help at these forum posts:


* [https://forum.freecadweb.org/viewtopic.php?t=19205 Windows]
* [https://forum.freecadweb.org/viewtopic.php?t=19205 Windows]
* [https://forum.freecadweb.org/viewtopic.php?t=18017 Linux]
* [https://forum.freecadweb.org/viewtopic.php?t=18017 Linux]

== Acknowledgments ==

Thank you to [http://www.anderswallin.net/about/ Dr. Anders Wallin] for providing OCL to the public.

Revision as of 08:58, 6 June 2019

OpenCamLib (OCL) is an open source library aiming to provide computer aided manufacturing (CAM) algorithms. FreeCAD uses OCL in the experimental 3D surface path operations and other experimental features.


Installing

Windows

  1. Obtain the Python version of OpenCamLib (OCL).
    • Build from source using the Python version used by your FreeCAD version. Peter Lama's fork of the same source has project files for a MSVC build.
    • Download the Python 2.7 binary by SGrogan on GitHub.
    • Download the Python 3.6 binary. (Currently no link)
  2. Navigate to your OCL build or binary folder
  3. Copy the ocl.pyd library file
  4. Proceed with one of the following four(4) options:
    • Navigate to your FreeCAD\lib folder, and paste the ocl.pyd file there. (This is the preferred option.)
    • Navigate to your FreeCAD\bin folder, and paste the ocl.pyd file there.
    • Navigate to your FreeCAD\Mod folder. Create a new folder, OCL. Enter the OCL folder and paste the ocl.pyd file.
    • Navigate to your %USERPROFILE%\AppData\Roaming\FreeCAD folder. Create a new folder, Mod. Enter the Mod folder. Create a new OCL folder. Enter the OCL folder and paste the ocl.pyd file. (This is the least preferred option.)
  5. Restart FreeCAD
  6. Verify proper installation
    1. Click ViewPanelsPython console.
    2. Type "import ocl" into the Python console and press the enter key.
    3. If no error appears, you have correctly installed OCL
      • If you receive an error:
        • Check the placement and name of the ocl.pyd file as instructed above
        • Verify the correct architecture type of the OCL library you installed - x86 or x64
        • Verify the Python version used to build the OCL library is the same as that of your FreeCAD software - 2.7 or 3.6 currently

Linux

The repository is here and contains basic installation instructions.

Before beginning installation, or during the intallation process, you will probably find you need to install some additional packages:

For example:

   sudo apt install cmake
   sudo apt install libboost-program-options-dev
   sudo apt-get install doxygen
   sudo apt-get install texlive-full

Mac

(No entry)


More help

In case you run into difficulties, you may find additional help at these forum posts:

Acknowledgments

Thank you to Dr. Anders Wallin for providing OCL to the public.