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.4.0.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tagreader-5.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 8cf8dd7f522cc27232d9cf1c5e516ebb3a693db0aa7421eaaf49d7cf461a04d2
MD5 02306ce270d86db2a25644105f5f9687
BLAKE2b-256 611d41432c6a7a4dfa13236c87b678c2e5ca79d3648e9bd1d7735d6effa33808

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tagreader-5.4.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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ae69cf435dd91a54658451d0847b2ba00b7144a0dce277ed34283e265601cad
MD5 1e372d2894a3ee5a2d098e8929d9d315
BLAKE2b-256 6ed6b8c8180b9fcfc706732e3c58d17289704e823da7b731c226ecb2288eb81f

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