Installation

Dependencies and Installation

This guide will walk you through setting up the Jua SDK for your project.

System Requirements

Before you begin, ensure your environment can meet these fundamental needs for the Jua SDK to function correctly:

• Python: Version 3.11 or higher.

• Zarr: Version 3.0 or newer.

Tip: try uv, an extremely fast Python package and project manager.

uv init && uv add jua

Installation Methods

We strongly recommend using a virtual environment to manage your project's dependencies. This prevents conflicts with other Python projects or your system-wide Python installation.

Installation using pip

1. Ensure you have Python 3.11 or higher. You must have a Python 3.11+ interpreter installed and available in your PATH. You can download it from python.org if needed.

2. Install jua:

   pip install jua

   This command will download and install jua and its dependencies (including a compatible Zarr version) from the Python Package Index (PyPI).

Installation using uv (optional)

uv is an extremely fast Python package installer and resolver. It's designed as a drop-in replacement for pip and pip-tools and can significantly speed up your workflows.

1. Set up your project and install jua: Navigate to your desired project directory or create a new one:

   mkdir my-jua-project
   cd my-jua-project

   Then, initialize a uv managed environment and add jua:

   uv init
   uv add jua

2. Run your Python scripts:

   uv run your_script_using_jua.py