Skip to content

Commit

Permalink
Updated docs to remove references to OpenSCAD/Blender.
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Vin committed Dec 19, 2023
1 parent 21ee673 commit 85e33f1
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/_templates/installation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Next, activate the `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ in which you want to install Scenic.
Activate the `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ in which you want to install Scenic.
To create and activate a new virtual environment called :file:`venv`, you can run the following commands:

.. venv-setup-start
Expand Down
14 changes: 4 additions & 10 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,23 @@ If you encounter any errors, please see our :doc:`install_notes` for suggestions

.. tab:: macOS

Start by downloading `Blender <https://www.blender.org/download/>`__ and `OpenSCAD <https://openscad.org/downloads.html>`__ and installing them into your :file:`Applications` directory.

.. include:: _templates/installation.rst

.. tab:: Linux

Start by installing the Python-Tk interface, Blender, and OpenSCAD.
Start by installing the Python-Tk interface.
You can likely use your system's package manager; e.g. on Debian/Ubuntu run:

.. code-block:: text
sudo apt-get install python3-tk blender openscad
For other Linux distributions or if you need to install from source, see the download pages for `Blender <https://www.blender.org/download/>`__ and `OpenSCAD <https://openscad.org/downloads.html>`__.
sudo apt-get install python3-tk
.. include:: _templates/installation.rst

.. tab:: Windows

These instructions cover installing Scenic natively on Windows; if you are using the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ (on Windows 10 and newer), see the WSL tab instead.

Start by downloading and running the installers for `Blender <https://www.blender.org/download/>`__ and `OpenSCAD <https://openscad.org/downloads.html>`__.

.. include:: _templates/installation.rst
:end-before: .. venv-setup-start

Expand All @@ -64,12 +58,12 @@ If you encounter any errors, please see our :doc:`install_notes` for suggestions
These instructions cover installing Scenic on the Windows Subsystem for Linux (WSL).

If you haven't already installed WSL, you can do that by running :command:`wsl --install` (in either Command Prompt or PowerShell) and restarting your computer.
Then open a WSL terminal and run the following commands to install Python, the Python-Tk interface, Blender, and OpenSCAD:
Then open a WSL terminal and run the following commands to install Python and the Python-Tk interface:

.. code-block:: text
sudo apt-get update
sudo apt-get install python3 python3-tk blender openscad
sudo apt-get install python3 python3-tk
.. include:: _templates/installation.rst
:end-before: .. venv-setup-start
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/region_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ When checking containment of an `Object` in a 2D region, Scenic will atuomatical

Most 3D regions inherit from either `MeshVolumeRegion` or `MeshSurfaceRegion`, which represent the volume (of a watertight mesh) and the surface of a mesh respectively. Various region classes are also provided to create primitive shapes. `MeshVolumeRegion` can be converted to `MeshSurfaceRegion` (and vice versa) using the the ``getSurfaceRegion`` and ``getVolumeRegion`` methods.

Mesh regions can use one of two engines for mesh operations: Blender or OpenSCAD. This can be controlled using the ``engine`` parameter, passing ``"blender"`` or ``"scad"`` respectively. Blender is generally more tolerant but can produce unreliable output, such as meshes that have microscopic holes. OpenSCAD is generally more precise, but may crash on certain inputs that it considers ill-defined. By default, Scenic uses Blender internally.

PolygonalFootprintRegions represent the :term:`footprint` of a 2D region. See `2D Regions` for more details.

.. autoclass:: scenic.core.regions.MeshVolumeRegion
Expand Down

0 comments on commit 85e33f1

Please sign in to comment.