Skip to content

A Python package for reading trend data from the OSIsoft PI and Aspen InfoPlus.21 historians

License

Notifications You must be signed in to change notification settings

equinor/tagreader-python

Repository files navigation

tagreader-python

GitHub Build Status PyPI - Python Version PyPI Downloads

Tagreader is a Python package for reading timeseries data from the OSIsoft PI and Aspen Infoplus.21 Information Manufacturing Systems (IMS) systems. It is intended to be easy to use, and present as similar interfaces as possible to the backend historians.

Installation

You can install tagreader directly into your project from pypi by using pip or another package manager. The only requirement is Python version 3.8 or above.

pip install tagreader

The following are required and will be installed:

  • pandas
  • requests
  • requests-kerberos
  • certifi
  • diskcache

Usage

Tagreader easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage you simply need to provide the corresponding IMS service URLs and IMSType. See data source for details.

Usage example

import tagreader
c = tagreader.IMSClient("mysource", "aspenone")
print(c.search("tag*"))
df = c.read_tags(["tag1", "tag2"], "18.06.2020 08:00:00", "18.06.2020 09:00:00", 60)

Note, you can add a timeout argument to the search method in order to avoid long-running search queries.

Jupyter Notebook Quickstart

Jupyter Notebook examples can be found in /examples. In order to run these examples, you need to install the optional dependencies.

pip install tagreader[notebooks]

The quickstart Jupyter Notebook can be found here

For more details, see the Tagreader Docs.

Documentation

The full documentation can be found in Tagreader Docs

Contribute

To starting contributing, please see Tagreader Docs - Contribute