Welcome to the quicfire-tools Documentation!

What is quicfire-tools?

quicfire-tools is a Python package that provides a convenient interface for programmatically creating and managing QUIC-Fire input file decks and processing QUIC-Fire output files into standard Python array data structures.

The goals of quicfire-tools are to:

1. Make it easy to write Python code to work with QUIC-Fire input and output files.
2. Unify code, scripts, and workflows across the QUIC-Fire ecosystem into a single package to support the development of new QUIC-Fire tools and applications.
3. Provide a platform for collaboration among QUIC-Fire developers and users.

Installation

quicfire-tools can be installed using pip or conda.

pip

pip install quicfire-tools

conda

Conda support is coming soon!

Issues

If you encounter any issues with the quicfire-tools package, please submit an issue on the quicfire-tools GitHub repository issues page.