Metadata-Version: 2.2
Name: pytrnsys_process
Version: 0.0.11
Summary: Post processing for pytrnsys
Author-email: Sebastian Swoboda <sebastian@swoboda.ch>, Alex Hobé <alex.hobe@ost.ch>, Damian Birchler <damian.birchler@ost.ch>
Project-URL: Homepage, https://github.com/SPF-OST/pytrnsys_process
Project-URL: Issues, https://github.com/SPF-OST/pytrnsys_process/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: contourpy==1.3.1
Requires-Dist: cycler==0.12.1
Requires-Dist: fonttools==4.56.0
Requires-Dist: kiwisolver==1.4.8
Requires-Dist: lark==1.2.2
Requires-Dist: matplotlib==3.10.0
Requires-Dist: numpy==2.2.3
Requires-Dist: packaging==24.2
Requires-Dist: pandas==2.2.3
Requires-Dist: pillow==11.1.0
Requires-Dist: pyarrow==19.0.1
Requires-Dist: pyparsing==3.2.1
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: pytz==2025.1
Requires-Dist: six==1.17.0
Requires-Dist: tzdata==2025.1

# PyTrnsys Process
[![Coverage Status](https://coveralls.io/repos/github/SPF-OST/pytrnsys_process/badge.svg)](https://coveralls.io/github/SPF-OST/pytrnsys_process)

> Post processing toolkit for `pytrnsys`

📚 [Documentation](https://pytrnsys-process.readthedocs.io/en/latest/) | 🚀 [Examples](examples)

## 🚀 Quick Start

### Prerequisites

#### Required

- [Python 3.12](https://www.python.org/ftp/python/3.12.2/python-3.12.2-amd64.exe)
- Clone this repository:
  ```bash
  git clone https://github.com/SPF-OST/pytrnsys_process.git
  ```

#### Recommended

- [PyCharm Community IDE](https://www.jetbrains.com/pycharm/download)

### Installation

Run the following commands in your Windows Command Prompt from the `pytrnsys_process` directory:

1. Create and activate a virtual environment:
   ```bash
   py -3.12 -m venv venv
   venv\Scripts\activate
   ```

2. Install dependencies:
   ```bash
   python -m pip install wheel
   python -m pip install -r requirements\dev.txt
   ```

3. You're ready to use the `pytrnsys_process` API! 🎉

### Try it out

Run the example script:

```bash
python examples/ready-to-run/processing-example.py
```

## 🧪 Testing

Run benchmarking tests:

```bash
# Run only benchmarks
pytest --benchmark-only

# Skip benchmarks
pytest --benchmark-skip
```

## 📝 License

[Add your license information here]

## 🤝 Contributing

[Add contribution guidelines here]

