Skip to content

SPF-OST/pytrnsys_process

Repository files navigation

PyTrnsys Process

Coverage Status

Post processing toolkit for pytrnsys

📚 Documentation | 🚀 Examples

🚀 Quick Start

Prerequisites

Required

  • Python 3.12
  • Clone this repository:
    git clone https://github.com/SPF-OST/pytrnsys_process.git

Recommended

Installation

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

  1. Create and activate a virtual environment:

    py -3.12 -m venv venv
    venv\Scripts\activate
  2. Install dependencies:

    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:

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

🧪 Testing

Run benchmarking tests:

# Run only benchmarks
pytest --benchmark-only

# Skip benchmarks
pytest --benchmark-skip

📝 License

[Add your license information here]

🤝 Contributing

[Add contribution guidelines here]

About

Post-processing for pytrnsys

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages