54 lines
961 B
Markdown
54 lines
961 B
Markdown
# Installation Guide
|
|
|
|
## Requirements
|
|
|
|
- Python >= 3.9
|
|
- Dependencies listed in `pyproject.toml`
|
|
|
|
## Install from Source
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone <repository-url>
|
|
cd SP2XR_code/sp2xr
|
|
```
|
|
|
|
2. Install the package:
|
|
```bash
|
|
pip install -e .
|
|
```
|
|
|
|
For Jupyter notebook support:
|
|
```bash
|
|
pip install -e ".[notebook]"
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
Core dependencies include:
|
|
- `dask[dataframe]` >= 2024.6 - Parallel computing
|
|
- `dask[distributed]` - Distributed computing across multiple machines
|
|
- `dask-jobqueue` - Integration with job schedulers (SLURM)
|
|
- `pandas` >= 2.2
|
|
- `numpy` >= 1.26
|
|
- `pyyaml` - YAML configuration file parsing
|
|
- `psutil` - System and process utilities
|
|
|
|
## Development Setup
|
|
|
|
### Pre-commit Hooks
|
|
The repository uses pre-commit hooks for code quality:
|
|
|
|
```bash
|
|
pip install pre-commit
|
|
pre-commit install
|
|
```
|
|
|
|
Configured tools:
|
|
- **Black**: Code formatting
|
|
- **Ruff**: Linting and import sorting
|
|
|
|
### Testing
|
|
```bash
|
|
pytest tests/
|
|
``` |