Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 5.09 KB

InstallingAnchorSCAD.md

File metadata and controls

87 lines (55 loc) · 5.09 KB

Installing AnchorSCAD

AnchorSCAD can be downloaded using Git from the AnchorSCAD Github repository. It will also require the PythonOpenScad Git repository and a number of other easily downloadable tools.

This software is provided under the terms of the LGPL V2.1 license. See the License section in this document for more information.

Requirements

All the required PIP packages are provided in the requirements.txt in the AnchorSCAD Github repository.

Non PyPi PIP packages required are:

  • Python 3.9 or higher
  • OpenSCAD 2021.01 or higher - Use the 2023.12.22 Development Snapshot for better performance.
  • Graphviz 2.30.2 or higher (likely works with earlier versions)

Git is also required for downloading the AnchorSCAD and PythonOpenScad repositories and also for contributing any models to AnchorSCAD‘s .models package or bug fixes or improvements.

It is highly recommended that a Python IDE be used. While not endorsing any IDE in particular, I have found LiClipse (or Eclipse + Pydev) and VS Code work sufficiently well. An old fashioned simple editor and command line execution of shape modules may be used if that is a preference.

Linux (Debian, Ubuntu, Raspberry Pi OS)

On Linux (Debian, Ubuntu, Raspberry Pi etc based distros), the following commands pasted into a terminal running bash should result in a working environment.

sudo apt install openscad graphviz python3 git
mkdir -p ~/git
cd ~/git
git clone https://github.com/owebeeone/anchorscad.git
cd anchorscad
git clone https://github.com/owebeeone/pythonopenscad.git
pip3 install -r src/anchorscad/requirements.txt

### If you want the "stable" branch, use this after running the above.
git fetch origin stable:stable
git checkout stable

Windows

Download and install the latest versions of:

  • Python 3.9 or higher
  • OpenSCAD 2021.01 or higher - Use the 2023.12.22 Development Snapshot for better performance.
  • Graphviz 2.30.2 or higher (likely works with earlier versions)

After installing those packages, start a new “cmd” shell terminal and run the following:

cd %USERPROFILE%
mkdir git   # Don’t run if the git directory already exists.
cd git
git clone https://github.com/owebeeone/anchorscad.git
cd anchorscad
git clone https://github.com/owebeeone/pythonopenscad.git
pip3 install -r src/anchorscad/requirements.txt

REM ### If you want the "stable" branch, use this after running the above.
git fetch origin stable:stable
git checkout stable

Testing The Installation

To verify that it is installed you can run a module like so:

python3 src/anchorscad/run.py src/anchorscad/extrude.py

Or you can run a longer test where every shape is run and images of all example shapes are created.

python3 src/anchorscad/run.py src/anchorscad/runner/anchorscad\_runner.py ../..

The generated files will reside in “src/anchorscad/runner/generated”.

Running AnchorSCAD Modules

Once everything is installed, you can open your favourite IDE but you will need to set the appropriate PYTHONPATH environment variable.

You can also use the “python3 src/anchorscad/run.py” command to run Python modules that depend on AnchorSCAD or PythonOpenSCAD which only sets the PYTHONPATH environment variable and current directory to the appropriate locations.

You can now check out the Quick Start instructions to start building your models.

License

AnchorSCAD is available under the terms of the GNU LESSER GENERAL PUBLIC LICENSE.

Copyright (C) 2022 Gianni Mariani

AnchorSCAD and PythonOpenScad is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA