THIS REPOSITORY IS NOW DEPRECATED, USE: https://github.com/SheffieldSolar/SS-Utilities

SS-Utilities

A collection of generic, re-usable Python utilities.

What is this repository for?

• Cool Python functions that are re-usable.
• Version 0.8.1
• Developed and tested with Python 3.8

How do I get set up?

• Make sure you have Git installed - Download Git
• Run pip install git+https://github.com/SheffieldSolar/SS-Utilities.git
  • NOTE: You may need to run this command as sudo on Linux machines depending, on your Python installation i.e. sudo pip install git+https://github.com/SheffieldSolar/SS-Utilities.git

Getting started

Example usage:

from ss_utilities.error_stat import r_squared, wMAPE, pearson_correlation
from ss_utilities.generic_tools import print_progress, query_yes_no, ascii_bar_chart

# Do Something

Documentation

• To Do

How do I upgrade?

To upgrade the code:

• Run pip install --upgrade git+https://github.com/SheffieldSolar/SS-Utilities.git

Contribution Guidelines

• To Do

Who do I talk to?

• Jamie Taylor - jamie.taylor@sheffield.ac.uk - SheffieldSolar

Authors

• Jamie Taylor - Initial work - SheffieldSolar

License

No license is defined yet - use at your own risk.