https://github.com/equinor/tagreader-python
A Python package for reading trend data from the OSIsoft PI and Aspen InfoPlus.21 historians
https://github.com/equinor/tagreader-python
aspentech infoplus21 ip21 odbc osisoft osisoft-pi rest-api
Last synced: about 1 month ago
JSON representation
A Python package for reading trend data from the OSIsoft PI and Aspen InfoPlus.21 historians
- Host: GitHub
- URL: https://github.com/equinor/tagreader-python
- Owner: equinor
- License: mit
- Created: 2020-04-06T14:20:54.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T07:43:53.000Z (about 2 months ago)
- Last Synced: 2025-04-11T09:39:16.382Z (about 2 months ago)
- Topics: aspentech, infoplus21, ip21, odbc, osisoft, osisoft-pi, rest-api
- Language: Python
- Homepage: https://equinor.github.io/tagreader-python/
- Size: 2.15 MB
- Stars: 52
- Watchers: 4
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# tagreader-python
[](https://pepy.tech/project/tagreader)
Tagreader is a Python package for reading timeseries data from the OSIsoft PI and Aspen Infoplus.21
Information Management Systems (IMS). It is intended to be easy to use, and present as similar interfaces
as possible to the backend plant historians.
## Installation
You can install tagreader directly into your project from pypi by using pip
or another package manager. Supports Python version 3.9.2 and above.
```shell
pip install tagreader
```
## Usage
Tagreader is 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](https://equinor.github.io/tagreader-python/docs/about/usage/data-source) for details.
### Usage example
```python
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.
```shell
pip install tagreader[notebooks]
```
The quickstart Jupyter Notebook can be found [here](https://github.com/equinor/tagreader-python/blob/main/examples/quickstart.ipynb)
For more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-python/).
## Documentation
The full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)
## Contribute
To starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)