Skip to content

Latest commit

 

History

History
169 lines (109 loc) · 3.25 KB

INSTALL.md

File metadata and controls

169 lines (109 loc) · 3.25 KB
Raw

Installation

Original Forked INSTALL (wont apply to this project)

Compiled versions (Linux, Windows 10 and 11)

You can download compiled versions for Linux and Windows (10/11).

Download the .msi or tar.gz for the appropriate OS from the download page at https://pygpt.net and then extract files from the archive and run the application.

Snap Store

PyPi (pip)

The application can also be installed from PyPI using pip install:

  1. Create virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install from PyPi:
pip install odaia
  1. Once installed run the command to start the application:
odaia

Source Code

An alternative method is to download the source code from GitHub and execute the application using the Python interpreter (version 3.10 or higher).

Running from GitHub source code

  1. Clone git repository or download .zip file:
git clone https://github.com/jgwill/odaia.git
cd odaia
  1. Create virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install requirements:
pip install -r requirements.txt
  1. Run the application:
python3 run.py

Install with Poetry

  1. Clone git repository or download .zip file:
git clone https://github.com/jgwill/odaia.git
cd odaia
  1. Install Poetry (if not installed):
pip install poetry
  1. Create a new virtual environment that uses Python 3.10:
poetry env use python3.10
poetry shell
  1. Install requirements:
poetry install
  1. Run the application:
poetry run python3 run.py

Tip: you can use PyInstaller to create a compiled version of the application for your system (required version >= 6.0.0).

Troubleshooting

If you have a problems with xcb plugin with newer versions of PySide on Linux, e.g. like this:

qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
This application failed to start because no Qt platform plugin could be initialized. 
Reinstalling the application may fix this problem.

...then install libxcb:

sudo apt install libxcb-cursor0

If you have a problems with audio on Linux, then try to install portaudio19-dev and/or libasound2:

sudo apt install portaudio19-dev -y

sudo apt install libasound2 -y
sudo apt install libasound2-data -y 
sudo apt install libasound2-plugins -y

python3 run.py --legacy=1

and to force disable OpenGL:

python3 run.py --disable-gpu=1

You can also manualy enable legacy mode by editing config file - open the %WORKDIR%/config.json config file in editor and set the following options:

"render.engine": "legacy",
"render.open_gl": false,

Other requirements

For operation, an internet connection is needed (for API connectivity), a registered OpenAI account, and an active API key that must be input into the program.

The API key can be obtained by registering on the OpenAI website:

https://platform.openai.com

Your API keys will be available here:

https://platform.openai.com/account/api-keys