survival 1.0.17

A high-performance survival analysis library written in Rust with Python bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

# Python Binding Tests

This directory contains tests for the Python bindings of the survival-rs library.

## Test Files

- `test_core.py` - Tests for core functions (coxcount1, coxcount2)
- `test_specialized.py` - Tests for specialized functions (cipoisson, norisk, finegray)
- `test_utilities.py` - Tests for utility functions (collapse)
- `test_classes.py` - Tests for Python classes (LinkFunctionParams, PSpline)
- `test_surv_analysis.py` - Tests for survival analysis functions (agsurv4, agsurv5, agmart, survfitkm, survdiff2)
- `test_concordance_additional.py` - Concordance tests
- `test_regression.py` - Tests for regression models (survreg, coxmart, CoxPHModel, Subject)
- `test_edge_cases.py` - Tests for edge cases and boundary conditions
- `test_all.py` - Runner script to execute all tests

## Running Tests

### Run individual test file:
```bash
python3 test/test_core.py
```

### Run all tests:
```bash
python3 test/test_all.py
```

## Prerequisites

Before running tests, you must:

1. **Install BLAS libraries** (required for the module to run):
   - On Arch Linux: `sudo pacman -S openblas`
   - On Ubuntu/Debian: `sudo apt-get install libopenblas-dev`
   - On Fedora: `sudo dnf install openblas-devel`

2. **Build and install the Python module** - You have two options:

   ### Option 1: Development Mode (Recommended)
   ```bash
   # Create virtualenv (if not already created)
   python3 -m venv .venv
   
   # Install maturin in virtualenv
   .venv/bin/pip install maturin
   
   # Build and install in development mode
   VIRTUAL_ENV=.venv .venv/bin/maturin develop
   ```
   This installs the module in development mode in the virtualenv.

   ### Option 2: Build Wheel
   ```bash
   maturin build
   ```
   Then install the wheel:
   ```bash
   pip install target/wheels/survival_rs-*.whl --force-reinstall
   ```
   Or the tests will automatically extract and use the wheel if pip is not available.

## Running Tests

### Using the test runner script (recommended):
```bash
./test/run_tests.sh
```

### Using Python directly:
```bash
# With virtualenv
.venv/bin/python test/test_all.py

# Or with system Python
python3 test/test_all.py
```

**Note:** The tests will fail with "No module named 'survival'" if the module hasn't been built yet, or with "undefined symbol: cblas_sgemm" if BLAS libraries are missing. Both are expected - just install the prerequisites first.

## Note

These tests verify that the Python bindings are working correctly and that the functions can be called with appropriate arguments. They do not verify the statistical correctness of the results (that's what the Rust integration tests in this directory are for).