Developer Guide

This guide is for people interested in extending the technical capabilities of the framework.

Warning

Work in progress…

• Adding new transfers
• Adding new Components
  • 2. Adding Components to component.py
  • 3. Adding the transfers
  • 4. Adapting unifhy.Model
  • 5. Adapting the unit tests

Development Guidance

The UniFHy repository is at https://github.com/unifhy-org/unifhy. The recommended approach if you wish to make your changes available to all users of UniFHy is to create a branch on a fork of the repository, make the changes and create a Pull Request (PR) to the ‘main’ UniFHy branch once done. Marking the Pull Request as ‘Ready to Review’ triggers the unit tests to run, but these can also be triggered manually by changing the status of the PR to draft and back to ‘Ready to Review’.

To run/test UniFHy from your local copy in which you have made changes, you can install it into your active python environment by pointing pip at the repository containing the code: pip install /path/to/unifhy/repo. If further changes are made to the code in /path/to/unifhy/repo then you may need to uninstall (pip uninstall unifhy) and reinstall for them to be picked up in your envrionment.