Skip to main content

Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tagreader-5.5.0.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

tagreader-5.5.0-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file tagreader-5.5.0.tar.gz.

File metadata

  • Download URL: tagreader-5.5.0.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.13 Windows/10

File hashes

Hashes for tagreader-5.5.0.tar.gz
Algorithm Hash digest
SHA256 f1e97fc0ec9569ffa98b067e9d7b964cee52e501c6d4d97535dcde31178bb7bb
MD5 2cbd6979528366957eb2fbb5938eb405
BLAKE2b-256 e99fe4d058679ae43d1c5592b77ffc076cd24a34c6a9c511b84acd6f44bce13e

See more details on using hashes here.

File details

Details for the file tagreader-5.5.0-py3-none-any.whl.

File metadata

  • Download URL: tagreader-5.5.0-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.13 Windows/10

File hashes

Hashes for tagreader-5.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5057badebe76f1842b8fdd42763b3e5fa829ed1bbe25346e00437a89c6b87ae
MD5 f439825211e35cdba2b5c31a16b9525b
BLAKE2b-256 949db86596e846b1a170fb9c8339cbaecc21775676cb58575b00ee344041b4a9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page