Installation

Requirements

GEddySoft requires Python 3.11.7 or higher and the following dependencies:

Core Dependencies

All core dependencies are listed in requirements.txt and will be automatically installed:

  • numpy: For numerical computations

  • pandas: For data handling and time series operations

  • scipy: For signal processing and statistical functions

  • matplotlib: For plotting routines

  • h5py: For HDF5 file operations

  • hdfdict: For HDF5 dictionary operations

  • diptest: For statistical tests

Documentation Dependencies

These are only needed if you want to build the documentation locally:

  • sphinx

  • myst-parser

  • sphinx-rtd-theme

All dependencies with their version requirements are listed in requirements.txt:

# Core dependencies
numpy>=1.20.0
pandas>=1.3.0
scipy>=1.7.0
matplotlib>=3.4.0
h5py>=3.6.0
hdfdict>=0.3.0
diptest>=0.5.0
statsmodels>=0.13.0
multiprocess>=0.70.0
typing-extensions>=4.0.0

# Documentation dependencies
sphinx>=7.0.0
myst-parser>=2.0.0
sphinx-rtd-theme>=1.3.0

Installation Steps

  1. Clone the repository:

    git clone https://github.com/BernardHeinesch/GEddySoft.git
cd GEddySoft

  2. Create and activate a virtual environment (recommended):

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

  3. Install required packages:

    pip install -r requirements.txt

  4. Install GEddySoft in development mode:

    pip install -e .

Verification

To verify the installation:

  1. Check Python version:

    python --version  # Should be 3.11.7 or higher

  2. Try importing key dependencies:

    import numpy
import pandas
import h5py
import hdfdict
import diptest

Troubleshooting

If you encounter any issues during installation:

  1. Ensure you have Python 3.11.7 or higher

  2. Check that all required dependencies are installed

  3. Verify your system meets the minimum requirements

  4. Contact the maintainer if problems persist