Installation

Requirements

Quick Install

The easiest way to install EstraPy is using pip:

pip install estrapy

Or, if you’re using uv:

uv pip install estrapy

Verify Installation

To test if the installation was successful, run:

estrapy --version

You should see:

EstraPy 2.0.1

System package

The easiest way to install EstraPy is using pip as a system package. This way, you can use EstraPy from any terminal without activating a virtual environment.

pip install estrapy

or with uv:

uv pip install estrapy --system

For better dependency management and to avoid conflicts with other Python packages, it’s recommended to install EstraPy in a virtual environment. This allows you to create an isolated environment for EstraPy and its dependencies, ensuring that it doesn’t interfere with other projects or system packages.

Using venv

# Create a virtual environment
python -m venv estrapy-env

# Activate it (Windows)
estrapy-env\Scripts\activate

# Activate it (Linux/macOS)
source estrapy-env/bin/activate

# Install EstraPy
pip install estrapy

Using uv

# Create and activate virtual environment with uv
uv venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate     # Windows

# Install EstraPy
uv pip install estrapy

If you are using a virtual environment, remember to activate it each time before using EstraPy.

Manual Installation

From GitHub Releases

Download the latest .whl file from the releases page and install it:

pip install estrapy-2.0.1-py3-none-any.whl

Building from Source

If you want to build from source or contribute to development:

Using GitHub CLI:

gh repo clone ramsteak/EstraPy
cd EstraPy
python -m build
pip install dist/estrapy-2.0.1-py3-none-any.whl

Using git:

git clone https://github.com/ramsteak/EstraPy
cd EstraPy
python -m build
pip install dist/estrapy-2.0.1-py3-none-any.whl

Note: Building from source requires the build package:

pip install build

Updating EstraPy

To update to the latest version:

pip install --upgrade estrapy

Or with uv:

uv pip install --upgrade estrapy

Dependencies

EstraPy automatically installs its required dependencies during installation. Key dependencies include:

  • NumPy - Numerical computing
  • Matplotlib - Plotting and visualization
  • SciPy - Scientific computing

For a complete list of dependencies, see the requirements in the repository.

Next Steps

Once installed, proceed to the Quick Start Guide to run your first analysis.