Documentation

Docs/Installation

Installation & Requirements

ExoBengal requires Python 3.8 or higher. This guide covers multiple installation methods, prerequisites, verification steps, and troubleshooting for common issues.

Prerequisites

  • Python version: Python 3.8+ (3.9 or 3.10 recommended)
  • System requirements:
    • Minimum: 4GB RAM, dual-core CPU
    • Recommended: 8GB RAM, quad-core CPU
    • Disk space: ~500MB for models and data
  • TensorFlow: TensorFlow will run on CPU by default. GPU support requires CUDA toolkit (optional).

Installation Options

Install from PyPI (Recommended)

pip install exobengal

The simplest way to install ExoBengal with all dependencies.

Install from source

git clone https://github.com/gazi-faysal-jubayer/ExoBengal.git
cd ExoBengal
python -m venv .venv && source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -U pip
pip install -r requirements.txt

Install from source for development or to access the latest features.

Development Mode

git clone https://github.com/gazi-faysal-jubayer/ExoBengal.git
cd ExoBengal
pip install -e .

Install in editable mode for active development.

Dependencies

numpy
pandas
matplotlib
seaborn
scikit-learn
joblib
tensorflow

Descriptions for each dependency:

  • numpy: Numerical computing
  • pandas: Data manipulation
  • matplotlib: Plotting and visualizations
  • seaborn: Statistical visualizations
  • scikit-learn: ML algorithms (RF, kNN, Decision Tree)
  • joblib: Model serialization
  • tensorflow: Deep learning (CNN)

Note: For Apple Silicon Macs, use: pip install tensorflow-macos tensorflow-metal

Verification

Verify your installation with these steps:

1. Basic Import Test

python -c "import exobengal; print('exobengal OK')"

2. Version Check

import exobengal
print(f"ExoBengal version: {exobengal.__version__}")

3. Model Loading Test

from exobengal import DetectExoplanet
detector = DetectExoplanet()
detector.load_rf_model()
print("Models loaded successfully!")

Troubleshooting Installation

Common Issues

1. TensorFlow Installation Issues

Problem: ModuleNotFoundError for tensorflow

Solution: pip install tensorflow-cpu (for CPU-only)

2. Model Files Not Found

Problem: FileNotFoundError for model files

Solution: Download pre-trained models from repository or train your own

3. Import Errors

Problem: Cannot import DetectExoplanet

Solution: Reinstall with pip install --upgrade exobengal

Virtual Environment Setup (Recommended)

Using a virtual environment prevents dependency conflicts and keeps your system clean.

Using venv

python -m venv exobengal_env
source exobengal_env/bin/activate  # Windows: exobengal_env\Scripts\activate
pip install exobengal

Using conda

conda create -n exobengal python=3.10
conda activate exobengal
pip install exobengal
Interstellar
Background Music
30%