Installation
Get Ganimede installed on your system and verify that everything is working correctly.Prerequisites
Before installing Ganimede, ensure you have:- Python 3.8 or higher: Ganimede requires Python >= 3.8
- pip: Python package installer (usually included with Python)
Install Ganimede
Install via pip
Install Ganimede using pip:This will install Ganimede and all required dependencies, including:
- Starlette for the web framework
- Uvicorn for ASGI server
- Jupyter client for notebook execution
- Ypy-websocket for real-time collaboration
Verify installation
Verify that Ganimede is installed correctly by checking the command:This should display the command usage and options.
If you’re using a virtual environment (recommended), make sure to activate it before installing Ganimede.
Dependencies
Ganimede automatically installs the following key dependencies:- starlette (0.23.1): Web framework for building the API
- uvicorn (0.20.0): ASGI server for running the application
- jupyter_client (7.4.9): Jupyter protocol client for code execution
- ipykernel (6.20.2): IPython kernel for Jupyter
- websockets (11.0.3): WebSocket support for real-time communication
- ypy-websocket (0.12.1): Yjs CRDT synchronization server
- black (23.1.0): Code formatter
- rich (13.2.0): Terminal formatting
- click (8.1.3): Command-line interface creation
Troubleshooting
Command not found: ganimede
Command not found: ganimede
If you get a “command not found” error, ensure that your Python scripts directory is in your PATH. You may need to add
~/.local/bin (Linux/Mac) or %APPDATA%\Python\Scripts (Windows) to your PATH.Python version issues
Python version issues
If you have multiple Python versions installed, you may need to use
pip3 instead of pip:Permission errors
Permission errors
If you encounter permission errors during installation, try installing in user mode:
Next steps
Now that Ganimede is installed, you’re ready to launch your first notebook.Quick start
Learn how to launch a notebook and start using Ganimede