Skip to content

Commit

Permalink
Update install_notes.rst
Browse files Browse the repository at this point in the history
-Revised pyglet installation instructions for Apple silicon based on review feedback.
-Suggested running pip install pyglet==1.5.26 in the virtual environment instead of editing pyproject.toml.
-Removed the pip freeze check.
  • Loading branch information
lola831 authored Nov 13, 2024
1 parent 7e09e03 commit c0c0d95
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/install_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,10 @@ If on an Apple-silicon machine you get an error related to pip being unable to i
Scenic generates only one scene on Apple silicon
+++++++++++++++++++++++++++++++++++++++++++++++++++

If on an Apple-silicon machine you get an error where your run a ``.scenic`` file and it only generates a single scene, you may need to downgrade the version of ``pyglet`` as follows:
If you're using an Apple-silicon machine and you encounter an issue where running a ``.scenic`` file generates only a single scene, try the following steps to adjust the ``pyglet`` version:

1. Follow the MacOS instructions on :ref:`quickstart` for the repository installation.
2. Inside the root of the Scenic repo, update the ``pyglet`` version from ``"pyglet ~= 1.5"`` to ``"pyglet == 1.5.26"``.
3. Activate the virutal environment if you haven't done so already and run: ``python -m pip install -e .``
4. Confirm that you are using the updated version of ``pyglet`` by running: ``pip freeze``.
1. Complete the usual Scenic installation steps, including activating a virtual environment.
2. Run: ``pip install pyglet==1.5.26``

For more updates on the related issue, please refer to the `GitHub open issue <https://github.com/BerkeleyLearnVerify/Scenic/issues/230>`_.

Expand Down

0 comments on commit c0c0d95

Please sign in to comment.