Skip to content

Installation

Installation

Getting started with LDA is simple. The recommended way is using the uv package manager.

Requirements

  • Python 3.9 or higher
  • uv package manager (recommended)
  • Git (optional, for development installation)

The fastest way to install LDA is using uv:

uv tool install ldanalysis

That's it! You can now start using LDA. Verify your installation:

ldanalysis --version

Alternative Installation Methods

Using pip

If you prefer traditional pip installation:

pip install ldanalysis

Note: The package name is ldanalysis (not lda which is used by another package).

Using pipx (Isolated Environment)

For an isolated installation:

pipx install ldanalysis

From Source

To install the latest development version:

git clone https://github.com/drpedapati/LDA.git
cd LDA
uv pip install -e .

Platform-Specific Instructions

macOS

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install LDA
uv tool install ldanalysis

Windows

# Install uv using PowerShell
irm https://astral.sh/uv/install.ps1 | iex

# Install LDA
uv tool install ldanalysis

Linux

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install LDA
uv tool install ldanalysis

Verify Installation

After installation, verify that LDA is working correctly:

# Check version
ldanalysis --version

# View help
ldanalysis --help

# Test initialization
ldanalysis init --name "Test Project" --dry-run

Upgrading

To upgrade to the latest version:

uv tool upgrade ldanalysis

Development Installation

For contributors and developers:

# Clone the repository
git clone https://github.com/drpedapati/LDA.git
cd LDA

# Create virtual environment
uv venv

# Install in development mode
uv pip install -e .

# Install development dependencies
uv pip install -e ".[dev]"

Troubleshooting

Common Issues

Command Not Found

If ldanalysis is not found after installation:

# Check if uv tools are in PATH
export PATH="$HOME/.local/bin:$PATH"

# Or reinstall
uv tool install --force ldanalysis

Permission Denied

On Unix systems, you may need to add the tools directory to PATH:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Package Name Confusion

Remember: - Install with: uv tool install ldanalysis - Run with: ldanalysis (not lda)

Getting Help

If you encounter issues:

  1. Check the troubleshooting guide
  2. Search existing issues
  3. Ask in discussions
  4. Report a new issue

Next Steps

Now that you have LDA installed, proceed to: