Support

Overview

HydroSight is an ongoing project that offers support to users, but it is dependent upon non-financial community support. Below are ways that you can contribute, and ways that we can support you in using HydroSight.

Giving Support to HydroSight

HydroSight is an ongoing research project and its funding depends upon evidence of impact. You can help support its future development by:

1. Giving us a GitHub star ⭐ (in the top right). Note, you'll need to login to GitHub to give a star.
2. Citing the relevant journal papers in any work that you publish (using the "Cite Project" option to get a reference list).
3. Posting a summary of how you've used HydroSight to the Discussion Forum. Details about the location of the application, the issues faced and how HydroSight contributed is greatly appreciated. Please add references to reports and papers - if they exist.
4. Contribute new modules, or de-bugging code, by:
   • forking HydroSight this repository;
   • Install git (if not already installed).
   • Install git-lfs, so that the .mat binary files containing data can be downloaded (if not already installed).
   • Create a local folder for your HydroSight code.
   • Clone your fork to the local folder using, say GitHub Desktop.
   • Making the desired changes to the forked code;
   • Summarising the changes by adding to ChangeLog.txt;
   • Adding to the suite of tests, if major changes or new features are proposed;
   • Committing and pushing your changes to your GitHub fork; and then
   • Creating a Pull request to integrate your work into the original HydroSight repository.

Getting Support in Using HydroSight

In addition it the online tutorial and online documentation, there are a number of ways to get support:

• Review the journal papers explaining aspects of Hydrosight.
• Posting a question to the Discussion Forum.
• Visit the FAQs.
• Get in contact with the creators of HydroSight.

Lastly, the project team would be excited about discussion collaborations, such as new features or applications. To get in touch please email Dr. Tim Peterson at tim.peterson@monash.edu.au.