Skip to content

MAINTENANCE.md

Latest commit

 

History

History
90 lines (58 loc) · 1.32 KB

MAINTENANCE.md

File metadata and controls

90 lines (58 loc) · 1.32 KB

🛠️ ReadIM Maintenance Guide

This project contains a C++ library with a Python wrapper for reading IM7 and VC7 files.
This document explains the steps to install the project and run the test suite locally.

✅ Local Requirements

  • Python 3.7 or higher
  • Git (to clone the project or install with pip install -e)
  • A virtual environment (venv) is recommended

🐍 Create and Activate a Virtual Environment

🔹 Windows

cd .\ReadIM
python -m venv venv
venv\Scripts\activate

🔹 Linux/macOS

cd ~/ReadIM
python3 -m venv venv
source venv/bin/activate

📦 Install Dependencies

Ensure your requirements.txt file contains at least:

numpy==2.2.4
pytest==8.3.5

Then, install dependencies:

pip install -r requirements.txt

🧩 Install the Project in Editable Mode

This allows Python to recognize the local ReadIM/ module:

pip install -e .

🧪 Run the Test Suite

pytest

For more detailed output:

pytest -v

🔚 Deactivate the Virtual Environment

deactivate

🧠 Additional Notes

  • Run tests from the root of the project (where setup.py is located).
  • If you see ModuleNotFoundError: No module named 'ReadIM', make sure you've run pip install -e ..