🤢 Troubleshooting - Manim-Notebook/manim-notebook GitHub Wiki

Before opening a new issue:

  • Search for related keywords in the issues. Remove the is:open flag to also search for already closed issues.
  • Make sure you are really encountering a Manim Notebook issue. We can't fix issues related to Manim itself here.

📜 Record Log File

To analyze your problem, we need a log file from you. Here is how to record one:

  • Open the command palette Ctrl/Cmd + Shift + Pand use the command Manim Notebook: Record Log File.
  • Then set the log level by searching for Manim Notebook and selecting Trace.
  • Now reproduce the issue, e.g. by running a command that causes the problem or previewing a certain Manim cell etc.
  • Once you're done, click on the button in the status bar (bottom right) to finish recording. The log file will be opened afterwards in your native file explorer (e.g. Windows explorer, macOS Finder etc.).
  • Drag-and-drop the log file into the GitHub issue text field (as a file, i.e. please don't copy-paste its content because this would make the issue hard to read due to its length).

Windows Paste Patch

[!tip] If you get the error message that the patch couldn't be applied, try to restart VSCode and see if that helps.

If you're Windows, paste commands to terminals are specially handled. Unfortunately, this caused a bug, where you could not execute any IPython cell when we programatically send some commands to the terminal. Instead, the cell enters the multi-line mode and you cannot exit it programmatically. See issue #18 on our side, this issue on the IPython side and finally this issue on the prompt-toolkit side (which IPython makes use of). A nice summary of what causes the bug can be found in this comment.

But we didn't want to exclude Windows users from our Manim Notebook extension. That's why we provide you with this Python patch to fix the problem. When you start the extension, we try to install this patch in your site-packages directory (of your Python installation or your currently active virtual environment).

By doing so, the patch is executed whenever the Python interpreter is started. It should hopefully not interfere with anything else. If you still wish to delete the patch, run python3 -c "import sysconfig; print(sysconfig.get_path('purelib'))". The resulting path is the folder, in which we installed two files for you:

  • __manim_notebook_windows_paste_patch.pth
  • __manim_notebook_windows_paste_patch.py

Just delete those to get rid of the patch (but keep in mind it will be reinstalled the next time you start our extension). If you encounter any issues with this patch, please let us know by creating a new issue.