Installation

Requirements

• Python >= 3.10

• numpy >= 1.24

• scipy >= 1.10

• networkx >= 3.0

• matplotlib >= 3.7

• pandas >= 2.0

• PyYAML >= 6.0

• tabulate >= 0.9

• joblib >= 1.3

Install from Source

Clone the repository and install in editable mode:

git clone https://github.com/sft-wick/sft-wick.git
cd sft-wick
pip install -e .

The parallel extra is retained for compatibility with older install commands; joblib is now part of the default runtime install.

pip install -e ".[parallel]"

To include development dependencies (pytest, pytest-cov):

pip install -e ".[dev]"

To include documentation-building dependencies (Sphinx, Furo, etc.):

pip install -e ".[docs]"

Verify Installation

python -c "from sft_wick import compute_moment; print('OK')"

Run the test suite:

pytest tests/ -v

Development Setup

1. Clone and install with dev + docs extras:

   pip install -e ".[dev,docs]"
   

2. Run tests:

   pytest tests/ -v
   

3. Build documentation locally:

   cd docs
   make html
   open _build/html/index.html