Merge pull request #2039 from mikedh/rc1

Release Candidate: 4.0.0rc1

Author: mikedh

Dockerfile

@@ -69,6 +69,10 @@ USER user
 # install things like pytest
 RUN pip install -e .[all]
 
+# check formatting
+RUN ruff trimesh
+RUN black --check trimesh
+
 # run pytest wrapped with xvfb for simple viewer tests
 RUN xvfb-run pytest --cov=trimesh \
     -p no:ALL_DEPENDENCIES \

README.md

@@ -7,9 +7,9 @@
 
 | :warning: WARNING          |
 |---------------------------|
-| `trimesh >= 4.0.0` on `main` makes minimum Python 3.7 and is in pre-release |
+| `trimesh >= 4.0.0` on `release-candidate` makes minimum Python 3.7 is in pre-release |
 | Testing with `pip install --pre trimesh` would be much appreciated! |
-| Projects that support Python<3.7 should update requirement to `trimesh<4` |
+| Projects that support `python<3.7` should update requirement to `trimesh<4` |
 
 
 Trimesh is a pure Python 3.7+ library for loading and using [triangular meshes](https://en.wikipedia.org/wiki/Triangle_mesh) with an emphasis on watertight surfaces. The goal of the library is to provide a full featured and well tested Trimesh object which allows for easy manipulation and analysis, in the style of the Polygon object in the [Shapely library](https://github.com/Toblerity/Shapely).

docker/vhacd.bash

@@ -61,7 +61,7 @@ def abspath(rel):
 # for a list of supported languages.
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -79,17 +79,9 @@ def abspath(rel):
 # The theme to use for HTML and HTML Help pages
 html_theme = "furo"
 
-# options for rtd-theme
+# options for furo
 html_theme_options = {
     "display_version": True,
-    "prev_next_buttons_location": "bottom",
-    "style_external_links": False,
-    # toc options
-    "collapse_navigation": True,
-    "sticky_navigation": True,
-    "navigation_depth": 4,
-    "includehidden": True,
-    "titles_only": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/conf.py

@@ -11,21 +11,18 @@
 import os
 import sys
 
-log = logging.getLogger('trimesh')
+log = logging.getLogger("trimesh")
 log.addHandler(logging.StreamHandler(sys.stdout))
 log.setLevel(logging.DEBUG)
 
 # current working directory
-pwd = os.path.abspath(os.path.expanduser(
-    os.path.dirname(__file__)))
+pwd = os.path.abspath(os.path.expanduser(os.path.dirname(__file__)))
 
 # where are our notebooks to render
-source = os.path.abspath(os.path.join(
-    pwd, '..', 'examples'))
+source = os.path.abspath(os.path.join(pwd, "..", "examples"))
 
 # which index file are we generating
-target = os.path.abspath(os.path.join(
-    pwd, "examples.md"))
+target = os.path.abspath(os.path.join(pwd, "examples.md"))
 
 
 def extract_docstring(loaded):
@@ -45,21 +42,23 @@ def extract_docstring(loaded):
       Cleaned up docstring.
     """
 
-    source = loaded['cells'][0]['source']
+    source = loaded["cells"][0]["source"]
 
     assert source[0].strip() == '"""'
     assert source[-1].strip() == '"""'
 
-    return ' '.join(i.strip() for i in source[1:-1])
+    return " ".join(i.strip() for i in source[1:-1])
 
 
-if __name__ == '__main__':
-
-    markdown = ['# Examples',
-                'Several examples are available as rendered IPython notebooks.', '', ]
+if __name__ == "__main__":
+    markdown = [
+        "# Examples",
+        "Several examples are available as rendered IPython notebooks.",
+        "",
+    ]
 
     for fn in os.listdir(source):
-        if not fn.lower().endswith('.ipynb'):
+        if not fn.lower().endswith(".ipynb"):
             continue
         path = os.path.join(source, fn)
         with open(path) as f:
@@ -68,10 +67,10 @@ def extract_docstring(loaded):
         log.info(f'`{fn}`: "{doc}"\n')
         link = f'examples.{fn.split(".")[0]}.html'
 
-        markdown.append(f'### [{fn}]({link})')
+        markdown.append(f"### [{fn}]({link})")
         markdown.append(doc)
-        markdown.append('')
+        markdown.append("")
 
-    final = '\n'.join(markdown)
-    with open(target, 'w') as f:
+    final = "\n".join(markdown)
+    with open(target, "w") as f:
         f.write(final)

docs/examples.py

@@ -71,16 +71,12 @@ if __name__ == '__main__':
 When you remove the embed and see the profile result you can then tweak the lines that are slow before finishing the function.
 
 ### Automatic Formatting
-Before opening a pull request I run some auto-formatting rules which will run autopep8 and yell at you about any `ruff` rule violations. There is a convenience script baked into `setup.py` to run all of these which you can run with:
+The only check in that's required to pass in CI is `ruff`, which I usually run with:
 ```
-python setup.py --format
+ruff . --fix
 ```
+It can fix a lot of formatting issues automatically. We also periodically run `black` to autoformat the codebase.
 
-This is equivalent to running `codespell`, `autopep8`, and `flake8` on trimesh, examples, and tests. You can also run it yourself with these options:
-```
-autopep8 --recursive --verbose --in-place --aggressive trimesh
-flake8 trimesh
-```
 
 ## Docstrings
 

docs/contributing.md docs/guides/contributing.mddocs/contributing.md renamed to docs/guides/contributing.md

@@ -18,7 +18,7 @@ If you\'d like most soft dependencies which should install cleanly on Mac, Windo
 pip install trimesh[easy]
 ```
 
-Or if you want the full experience, you can try the `all` extra, where packages may only be available for Linux:
+Or if you want the full experience, you can try the `all` extra which includes all the testing and recommended packages:
 ```
 pip install trimesh[all]
 ```
@@ -42,7 +42,7 @@ Ubuntu-Debian Notes
 Blender and openSCAD are soft dependencies used for boolean operations with subprocess, you can get them with `apt`:
 
 ```
-sudo apt-get install openscad blender
+sudo apt-get install blender
 ```
 
 Dependency Overview
@@ -54,31 +54,31 @@ Trimesh has a lot of soft-required upstream packages. We try to make sure they'r
 | Package | Description | Alternatives | Level |
 | ------  | ---------   | ----------   | ----- |
 | `numpy` | The base container for fast array types. | | `required` | 
-| `scipy` | Provides convex hulls (`scipy.spatial.ConvexHull`), fast graph operations (`scipy.sparse.csgraph`), fast nearest-point queries (`scipy.spatial.cKDTree`), b-spline evaluation (`scipy.interpolate`). | Nothing comes to mind, it does a whole heck of a lot. | `easy` |  
+| `scipy` | Provides convex hulls (`scipy.spatial.ConvexHull`), fast graph operations (`scipy.sparse.csgraph`), fast nearest-point queries (`scipy.spatial.cKDTree`), b-spline evaluation (`scipy.interpolate`). | | `easy` |  
 | `lxml` | Parse XML documents. We use this over the built-in ones as it was slightly faster, and there was a format implemented which was extremely annoying to handle without the ability to get parent nodes (which `lxml` has but built-in XML doesn't). | Standard library's XML | `easy` |
-| `networkx` | A nice-to-use pure Python graph library that's faster than you'd think. It implements DFS, BFS, and the usual FAANG-interview-question algorithms. A lot of the commonly run stuff in trimesh has been re-written to use `scipy.sparse.csgraph` as it's also an easy install and is way faster in most cases. But if you have a small-ish graph the API for `networkx` is way easier to "grok". | `graph-tool`, `scipy.sparse.csgraph` | `easy` |
-| `shapely` | Bindings to `GEOS` for 2D spatial stuff: "set-theoretic analysis and manipulation of planar features." It lets you offset, union, and query polygons nicely. | `clipper` maybe? | `easy` | 
+| `networkx` | Pure Python graph library that's reasonably fast and has a nice API. `scipy.sparse.csgraph` is way faster in most cases but is hard to understand and doesn't implement as many algorithms. | `graph-tool`, `scipy.sparse.csgraph` | `easy` |
+| `shapely` | Bindings to `GEOS` for 2D spatial stuff: "set-theoretic analysis and manipulation of planar features" which lets you offset, union, and query polygons. | `clipper` | `easy` | 
 | `rtree` | Query ND rectangles with a spatial tree for a "broad phase" intersection. Used in polygon generation ("given N closed curves which curve contains the other curve?") and as the broad-phase for the built-in-numpy slow ray query engine. | `fcl` maybe? | `easy` |
 |`requests`| Do network queries in `trimesh.exchange.load_remote`, will *only* make network requests when asked | | `easy`|
-|`sympy`| Evaluate symbolic algebra | | `easy`|
+|`sympy`| Evaluate symbolic algebra | | `recommend`|
 |`xxhash`| Quickly hash arrays, used for our cache checking | | `easy`|
-|`msgpack`| A serialization method that supports bytes-blobs. | `protobuf` | `easy`|
-|`chardet`| When we fail to decode text as UTF-8 we then check with chardet which guesses an encoding. This lets us load files even with weird encodings. | | `easy`|
+|`chardet`| When we fail to decode text as UTF-8 we then check with chardet which guesses an encoding,  letting us load files even with weird encodings. | | `easy`|
 |`colorlog`| Printing logs with colors. | | `easy`|
-|`pillow`| Reading raster images for textures, and rendering polygons into raster images. | | `easy`|
+|`pillow`| Reading raster images for textures and render polygons into raster images. | | `easy`|
 |`svg.path`| Parsing SVG path strings. | | `easy`|
 |`jsonschema`| Validating our exports for formats like GLTF. | | `easy`|
 |`pycollada`| Parse `dae` files. | | `easy`|
-|`pyglet`| OpenGL bindings for our simple debug viewer. | | `easy`|
-|`xatlas`| Unwrap meshes to generate UV coordinates quickly and well. | | `all`|
-|`python-fcl`| Do collision queries between meshes | | `all`|
-|`glooey`| Provide a viewer with widgets. | | `all`|
-|`meshio`| Load additional mesh formats. | | `all`|
-|`scikit-image`| Used in voxel ops | | `all`|
-|`mapbox-earcut`| Triangulate 2D polygons | `triangle` which has an unusual license | `all`|
-|`psutil`| Get current memory usage, useful for checking to see if we're going to run out of memory instantiating a giant array | | `all`|
+|`pyglet<2`| OpenGL bindings for our simple debug viewer. | | `recommend`|
+|`xatlas`| Unwrap meshes to generate UV coordinates quickly and well. | | `recommend`|
+|`python-fcl`| Do collision queries between meshes | | `recommend`|
+|`glooey`| Provide a viewer with widgets. | | `recommend`|
+|`meshio`| Load additional mesh formats. | | `recommend`|
+|`scikit-image`| Used in voxel ops | | `recommend`|
+|`mapbox-earcut`| Triangulate 2D polygons | `triangle` which has an unusual license | `easy`|
+|`psutil`| Get current memory usage, useful for checking to see if we're going to run out of memory instantiating a giant array | | `recommend`|
 |`ruff`| A static code analyzer that replaces `flake8`. | `flake8` | `test`|
-|`autopep8`| A code formatter which fixes whitespace issues automatically. | | `test`|
+|`black`| A code formatter which fixes whitespace issues automatically. | | `test`|
 |`pytest`| A test runner. | | `test`|
 |`pytest-cov`| A plugin to calculate test coverage. | | `test`|
 |`pyinstrument`| A sampling based profiler for performance tweaking. | | `test`|
+|`pyvhacd`| A binding for VHACD which provides convex decompositions | | `recommend`|

docs/docker.md docs/guides/docker.mddocs/docker.md renamed to docs/guides/docker.md

@@ -1,6 +1,3 @@
- .. toctree::
-   :maxdepth: 2
-  
 .. include:: README.rst
 
 Links
@@ -13,7 +10,7 @@ Install
 .. toctree::
    :maxdepth: 2
 
-   install.md
+   guides/install.md
 
 Examples
 ==========
@@ -27,14 +24,14 @@ Contributing
 .. toctree::
    :maxdepth: 1
 
-   Contributing <contributing.md>
+   Contributing <guides/contributing.md>
 
 Docker
 ==========  
 .. toctree::
    :maxdepth: 1
 
-   Docker <docker.md>
+   Docker <guides/docker.md>
 
 API Reference
 =============

docs/install.md docs/guides/install.mddocs/install.md renamed to docs/guides/install.md

@@ -3,11 +3,11 @@ recommonmark==0.7.1
 jupyter==1.0.0
 
 # get sphinx version range from furo install
-furo==2023.8.19
+furo==2023.9.10
 myst-parser==2.0.0
 pyopenssl==23.2.0
 autodocsumm==0.2.11
 jinja2==3.1.2
-matplotlib==3.7.2
-nbconvert==7.7.4
+matplotlib==3.8.0
+nbconvert==7.8.0