Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems. It is intended to be easy to use, and present as similar interfaces as possible to the backend historians.
Queries can be performed using either ODBC or REST API queries. ODBC queries require the installation of proprietary drivers from AspenTech and OSIsoft.
Tagreader outputs trend data as Pandas Dataframes, and uses the HDF5 file format to cache results.
Tagreader currently only works on Windows platforms, but can (and probably will) be modified to work on Linux using REST APIs.
Python >=3.7 with the following packages:
- pandas >= 1.0.0
- tables
- requests
- requests-kerberos
- certifi >= 2020.04.05
- pyodbc (if using ODBC connections)
If using ODBC connections, you must also install proprietary drivers for PI ODBC and/or Aspen IP.21 SQLPlus. These drivers are only available for Microsoft Windows.
To install and/or upgrade:
pip install --upgrade tagreader
If you wish to use ODBC connections to the IMS servers, you will also need some proprietary drivers. There is more information in the manual.
There is a quickstart example file that should get you going. Also check out the manual for more information.
All contributions are welcome, including code, bug reports, issues, feature requests, and documentation. The preferred way of submitting a contribution is to either make an issue on GitHub or by forking the project on GitHub and making a pull request.