Skip to content

installation.md

Latest commit

 

History

History
84 lines (59 loc) · 2 KB

installation.md

File metadata and controls

84 lines (59 loc) · 2 KB

Installation Guide

System Requirements

Python Version

Orion currently supports Python version 3.11.x.

Important Compatibility Notes:

  • Using other Python versions might lead to dependency conflicts caused by hunter, creating a challenging situation known as "dependency hell"
  • Python 3.12.x may result in errors due to the removal of distutils, a dependency used by numpy
  • This information is essential to ensure a smooth experience with Orion and avoid potential compatibility issues

Installation Steps

1. Clone the Repository

git clone <repository_url>
cd orion

2. Set Up Virtual Environment

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install Dependencies

pip install -r requirements.txt

4. Set Environment Variables

export ES_SERVER=<es_server_url>

5. Install Orion

pip install .

Install with uv

You will need to have uv installed, then you should run:

uv tool install -p 3.11 orion --from git+https://github.com/cloud-bulldozer/orion.git

Verification

After installation, verify that Orion is working correctly:

orion --help

You should see the help output with available commands and options.

Troubleshooting

Common Issues

Dependency Conflicts

If you encounter dependency conflicts, ensure you're using Python 3.11.x and consider creating a fresh virtual environment.

Environment Variables

Make sure the ES_SERVER environment variable is properly set. You can verify this with:

echo $ES_SERVER

Permission Issues

If you encounter permission issues during installation, you may need to use sudo or check your Python installation permissions.

Development Installation

For development purposes, you can install Orion in editable mode:

pip install -e .

This allows you to make changes to the code without reinstalling the package.