Installation

Prerequisites

Python 3.8 or higher
pip (Python package installer)

Install from PyPI

Once published, you can install wosecopy from PyPI:

pip install wosecopy

Install from Source

For development or to get the latest version:

git clone https://github.com/yourusername/wosecopy.git
cd wosecopy
pip install -e .

Download Language Models

After installation, download the required spaCy models:

English (Required)

python -m spacy download en_core_web_lg

Or use the CLI:

wosecopy download-model --language en --size lg

German (Optional)

python -m spacy download de_core_news_lg

Or use the CLI:

wosecopy download-model --language de --size lg

Verify Installation

Test that the package is installed correctly:

wosecopy --help

You should see the CLI help menu.

Virtual Environment (Recommended)

It’s recommended to use a virtual environment:

# Create virtual environment
python -m venv wosecopy-env

# Activate it
# On Windows:
wosecopy-env\Scripts\activate
# On Linux/Mac:
source wosecopy-env/bin/activate

# Install package
pip install wosecopy

# Download models
python -m spacy download en_core_web_lg

Dependencies

The following packages will be automatically installed:

spacy >= 3.0.0
pandas >= 1.3.0
numpy >= 1.21.0
networkx >= 2.6.0
matplotlib >= 3.4.0
seaborn >= 0.11.0
scikit-learn >= 1.0.0
scipy >= 1.7.0
tqdm >= 4.62.0
click >= 8.0.0

Development Installation

For development with testing and documentation tools:

pip install -e ".[dev]"

This installs additional packages:

pytest >= 6.2.0
pytest-cov >= 3.0.0
sphinx >= 4.0.0
sphinx-rtd-theme >= 1.0.0
black >= 21.0
flake8 >= 3.9.0

Troubleshooting

Model Not Found

Issue: OSError: [E050] Can't find model 'en_core_web_lg'

Solution: Download the model manually:

python -m spacy download en_core_web_lg

Import Error

Issue: ImportError: No module named 'wosecopy'

Solution: Make sure you’re in the correct directory and have installed the package:

pip install -e .

Permission Errors

Issue: Permission denied during installation

Solution: Use a virtual environment or install with --user flag:

pip install --user wosecopy