Omit pyopengl-accelarate due to missing tarball for linux on pip (#406)

* Omit pyopengl-accelarate due to missing tarball for linux on pip * Update release notes
p5py · Nov 15, 2022 · ff54444 · ff54444
1 parent 5506c88
commit ff54444
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 2 deletions.
diff --git a/docs/releasenotes/0.8.1.rst b/docs/releasenotes/0.8.1.rst
@@ -24,3 +24,43 @@ This release includes contributions from @tushar5526, @ziyaointl, @Mr-Sunglasses
 PS: There are a lot of good open issues that currently need help and we would love your contributions!
 
 
+NOTE
+----
+
+``pyopengl-accelarate`` is omitted from the ``requirements.txt``
+temporarily. See #397 for more information about this. If you are
+looking for better 3D performance you can install it from the
+``requirements.txt`` file.
+
++------------------+------------------+------------------+--------+
+| benchmark        | with             | without          | change |
+|                  | pyo              | pyo              |        |
+|                  | pengl-accelerate | pengl-accelerate |        |
++==================+==================+==================+========+
+| arcs             | 8.944169         | 9.764988         | 9.18%  |
++------------------+------------------+------------------+--------+
+| arm              | 2.612446         | 2.611884         | -0.02% |
++------------------+------------------+------------------+--------+
+| basic_shapes     | 2.629553         | 2.688781         | 2.25%  |
++------------------+------------------+------------------+--------+
+| begin_contour    | 2.684205         | 2.711441         | 1.01%  |
++------------------+------------------+------------------+--------+
+| curves           | 4.766132         | 4.962305         | 4.12%  |
++------------------+------------------+------------------+--------+
+| custom_shapes    | 4.643741         | 4.754362         | 2.38%  |
++------------------+------------------+------------------+--------+
+| custom_shapes2   | 3.75905          | 3.791483         | 0.86%  |
++------------------+------------------+------------------+--------+
+| point_demo       | 2.880713         | 2.939999         | 2.06%  |
++------------------+------------------+------------------+--------+
+| primitives       | 3.651718         | 3.717032         | 1.79%  |
++------------------+------------------+------------------+--------+
+| s                | 9.417307         | 9.437273         | 0.21%  |
+| pinning-cone_p3d |                  |                  |        |
++------------------+------------------+------------------+--------+
+| tetrahedron_p3d  | 8.114283         | 8.203861         | 1.10%  |
++------------------+------------------+------------------+--------+
+| triangle_strip   | 3.228278         | 3.228012         | -0.01% |
++------------------+------------------+------------------+--------+
+| world_p3d        | 26.883501        | 26.991062        | 0.40%  |
++------------------+------------------+------------------+--------+
diff --git a/p5/sketch/userspace.py b/p5/sketch/userspace.py
@@ -198,7 +198,7 @@ def run(
         elif mode == "P3D":
             p5.mode = "P3D"
             from p5.sketch.Vispy3DRenderer.renderer3d import Renderer3D
-
+            print("For better 3D performance, install pyopengl-accelarate from requirements.txt")
             p5.renderer = Renderer3D()
         else:
             ValueError("Invalid Mode %s" % mode)

diff --git a/requirements.txt b/requirements.txt
@@ -3,7 +3,8 @@ glfw==1.11.2
 numpy
 Pillow==9.0.1
 vispy==0.10.0
-PyOpenGL-accelerate@git+https://github.com/mcfletch/pyopengl.git@227f9c66976d9f5dadf62b9a97e6beaec84831ca#subdirectory=accelerate
+# See https://github.com/p5py/p5/issues/397 for more info on this
+# PyOpenGL-accelerate@git+https://github.com/mcfletch/pyopengl.git@227f9c66976d9f5dadf62b9a97e6beaec84831ca#subdirectory=accelerate
 PyOpenGL==3.1.6
 requests>=2.25.0
 dataclasses;python_version=="3.6"