Shyft: Open Source toolbox for the energy-market domain¶
Shyft is an Open Source modern computing framework the energy-market domain. It is constructed using high quality and performance open-source components in C++, exposed to python.
Currently it provides a high performance generic time-series framework and a spatially distributed conceptual hydrologic models.
The time-series framework allows the python user to work with time-series expressions, in a natural way like math-expressions, and the execution is performed by multi-core parallell execution in c++. The time-series framework also provides distributed time-series services, extensible by python, that can run on multiple servers.
The hydrological forecasting model framework allows for simulation of different algorithms in a highly efficient manner, while providing an interface to conduct more explorative evaluations of the hydrologic performance of the available algorithms. Shyft is not simply a model, nor is it a distinct “platform”.
The objectives of Shyft are to:
provide python-enabled tools and services, so that IT and business can combine their skills to reach the common goals
provide a flexible hydrologic forecasting toolbox built for operational environments
enable highly efficient / rapid calculations of hydrologic response at the regional scale
allow for using the multiple working hypothesis to obtain an optimal catchment forecast
create a mechanism for rapid implementation of improvements identified through research activities
To address the first and second objectives, computational efficiency and well test-covered software have been paramount. Shyft is inspired from research software that provided for the multiple working hypothesis. Shyft uses the latest C++ standards to make use of templated code in order to provide highly efficient code taking advantage of modern day compiler functionality minimizing risk of faulty code and memory leaks. To address the latter two objectives, the templated language functionality allows for the development of different algorithms that are then easily implemented into the framework. The api allows for accessing all the components of the framework, including the individual hydrologic routines easily and is exposed to both the C++ and Python languages allowing for rapid exploration of different model configurations and selection of an optimal forecast model.
Documentation of Shyft is available at shyft.readthedocs.io and is under continuous development.
Our primary source of documentation is through this website.
- Getting Started
- How Orchestration Works
- Configuring Shyft