Frequently Asked Questions

How can I contribute to rfbzero.py?

First off, thank you for taking the time to contribute! Everyone is welcome to contribute and all types of contributions are encouraged and valued. This includes code reviews, bug fixes, new features, examples, documentation, community participation, etc.

Feature requests and bug reports

If you want to make a suggestion for a new feature, please create an issue including as much detail as possible.

Contributing code

The preferred method for contributing code to rfbzero.py is to fork the repository on GitHub and create a pull request with the proposed changes. More detailed information on how to get started developing rfbzero.py can be found in CONTRIBUTING.md.

Feel free to reach out via GitHub issues with any questions!

How do I cite rfbzero.py?

https://joss.theoj.org/papers/10.21105/joss.06537/status.svg

If you use rfbzero.py in published work, please consider citing https://joss.theoj.org/papers/10.21105/joss.06537 as

@article{Fell2024,
    title = {{RFBzero: A Python package for zero-dimensional simulation of redox flow battery cycling}},
    author = {Fell, Eric M. and Fell, Jeremy A. and Aziz, Michael J.},
    doi = {10.21105/joss.06537},
    journal = {Journal of Open Source Software},
    publisher = {The Open Journal},
    volume = {9},
    number = {98},
    pages = {6537},
    year = {2024},
    url = {https://doi.org/10.21105/joss.06537},
}