Metadata-Version: 2.1
Name: asc2csv
Version: 1.3
Summary: A Python package for converting EyeLink .asc files to structured .csv files.
Home-page: https://github.com/AhsanKhodami/asc2edf
Author: Mohammad Ahsan Khodami
Author-email: ahsan.khodami@gmail.com
Project-URL: Source, https://github.com/AhsanKhodami/asc2edf
Project-URL: Tracker, https://github.com/AhsanKhodami/asc2edf/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.6
Description-Content-Type: text/markdown


# ascii2edf

**ascii2edf** is a Python package developed for converting EyeLink `.asc` files into structured `.csv` files, facilitating the analysis of eye-tracking data. It extracts gaze data and event details such as blinks, saccades, and fixations, organizing them into an easy-to-use format.

## Features
- Converts EyeLink `.asc` files to `.csv` format efficiently.
- Extracts and processes blink (`EBLINK`), saccade (`ESACC`), and fixation (`EFIX`) event data.
- Aligns timestamps relative to trial start for consistent temporal analysis.
- Handles missing data by combining event and sample data fields where applicable.

## Installation

To install the package, run:

```bash
pip install asc2csv
```

## Usage

Import the package and use the `process_asc_file()` function:

```python
import asc2csv as convert

convert.process_asc_file('input_file.asc', 'output_file.csv', header=True)
```

### Parameters
- **`input_file_path`** (str): Path to the input `.asc` file.
- **`output_csv_path`** (str): Path to save the output `.csv` file.
- **`header`** (bool, optional): Whether to include a header row in the output CSV. Default is `True`.

## Requirements
- Python >= 3.6
- `pandas`

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

## Contributing

Contributions are welcome! If you find a bug or have an idea for an improvement, please submit a pull request or open an issue.

## Creator and Maintainer

**Mohammad Ahsan Khodami**  
- Personal Site: [khodami.site](https://khodami.site)  
- Google Scholar: [Profile](https://scholar.google.com/citations?user=WCqPnS4AAAAJ&hl=en)  
- Email: [ahsan.khodami@gmail.com](mailto:ahsan.khodami@gmail.com)

## Acknowledgments
- The EyeLink system and data format are provided by SR Research.
