If you are interested in contributing to PSP-UFU you are most welcome!
Before starting with your contributions we recommend that you get to know the project better by visiting the PSP-UFU website and reading the published articles:
Oliveira, T. L., Guimarães, G. C., & Silva, L. R. C. (2019). PSP-UFU: An open-source, graphical, and multiplatform software for power system studies. International Transactions on Electrical Energy Systems, e12185. doi: 10.1002/2050-7038.12185
Oliveira, T. L., Guimarães, G. C., Silva, L. R., & Rezende, J. O. (2019). Power system education and research applications using free and open-source, graphical and multiplatform PSP-UFU software. The International Journal of Electrical Engineering & Education, 0020720919879058. doi: 10.1177/0020720919879058
In order to build the PSP-UFU in your machine, clone the GitHub repository and download the CodeLite IDE to open the Workspace file. All the project configuration are already done in this file.
The CodeLite provides a C++ compiler if you don't already have one.
Another requirement to build PSP-UFU is the GUI library wxWidgets. Build tutorials for wxWidgets can be found in wxWidgets' Wiki, here (Windows) and here (Linux).
Questions can be placed in Issue tracker.
The wxWidgets coding guide are used to writing code for inclusion into the PSP-UFU. Please, follow the guidelines with the following exceptions:
- Physical Files Organization: Always use the MVC pattern described in published papers;
- Use wx prefix for all public symbols: wx prefix are not needed;
- Restrictions on C++ Features: The are no C++ feature restrictions in PSP-UFU.
Use the comments to create your code documentation, using the Doxygen style.
The Project Documentation is your best friend! Explore it!
After your contribution, please send a pull request with detailed description in order to make clear the modifications and new features. Aways test your code with the samples projects before pull requests.
Good coding!
Thales