# Process Cytosim compression simulations


Notebook contains steps for post processing of Cytosim simulations in which a
single actin fiber is compressed at different compression velocities.

This notebook provides an example of processing a simulation series in which
there are multiple conditions, each of which were run with multiple replicates.
For an example of processing a simulation series with a single condition with
multiple replicates, see `process_cytosim_no_compression_simulations.py`.

- [Define simulation conditions](#define-simulation-conditions)
- [Parse simulation data](#parse-simulation-data)
- [Define sampling settings](#define-sampling-settings)
- [Sample simulation data](#sample-simulation-data)

```python
if __name__ != "__main__":
    raise ImportError("This module is a notebook and is not meant to be imported")
```

```python
from subcell_pipeline.simulation.cytosim.post_processing import (
    parse_cytosim_simulation_data,
)
from subcell_pipeline.simulation.post_processing import sample_simulation_data
```

## Define simulation conditions

Defines the `ACTIN_COMPRESSION_VELOCITY` simulation series, which compresses a
single 500 nm actin fiber at four different velocities (4.7, 15, 47, and 150
μm/s) with five replicates each (random seeds 1, 2, 3, 4, and 5).

```python
# Name of the simulation series
series_name: str = "ACTIN_COMPRESSION_VELOCITY"

# S3 bucket for input and output files
bucket: str = "s3://cytosim-working-bucket"

# Random seeds for simulations
random_seeds: list[int] = [1, 2, 3, 4, 5]

# List of condition file keys for each velocity
condition_keys: list[str] = ["0047", "0150", "0470", "1500"]
```

## Parse simulation data

Iterate through all condition keys and random seeds to load simulation output
files and parse them into a tidy data format. If the parsed file for a given
condition key and random seed already exists, parsing is skipped.

- Input: `(series_name)/outputs/(series_name)_(condition_key)_(index)/`
- Output: `(series_name)/data/(series_name)_(condition_key)_(seed).csv`

```python
parse_cytosim_simulation_data(bucket, series_name, condition_keys, random_seeds)
```

## Define sampling settings

Defines the settings used for sub sampling data timepoints and monomer points.

```python
# Number of timepoints
n_timepoints = 200

# Number of monomer points per fiber
n_monomer_points = 200
```

## Sample simulation data

Iterate through all condition keys and random seeds to load the parsed data and
sample the timepoints and monomer points. If the sampled file for a given
condition key and random seed already exists, sampling is skipped.

- Input: `(series_name)/data/(series_name)_(condition_key)_(seed).csv`
- Output: `(series_name)/samples/(series_name)_(condition_key)_(seed).csv`

```python
sample_simulation_data(
    bucket, series_name, condition_keys, random_seeds, n_timepoints, n_monomer_points
)
```