Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update example jupyter notebook #251

Merged
merged 1 commit into from
Aug 24, 2023
Merged

docs: update example jupyter notebook #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions examples/quickstart.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"If we don't know the name of the data source, we can check which PI and IP.21 servers we have access to via ODBC ([more details](../docs/manual.md#listing-available-data-sources)):"
"If we don't know the name of the data source, we can check which PI and IP.21 servers we have access to via Web API ([more details](https://equinor.github.io/tagreader-python/docs/about/usage/data-source)):"
]
},
{
Expand All @@ -42,30 +42,30 @@
},
"outputs": [],
"source": [
"tagreader.list_sources(\"pi\")"
"tagreader.list_sources(\"piwebapi\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Let's establish an ODBC connection to PINO. We need to specify that PINO is a PI server. "
"By default, a cache-file using SQLite will be created to store previously read data values [more details](https://equinor.github.io/tagreader-python/docs/about/usage/caching). The cache can significantly speed up rereading of data, and it is recommended to always keep it enabled. If, for any reason, you want to disable the cache, set it to `None` when you are making the connection object."
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": [
"c = tagreader.IMSClient(\"PINO\", \"pi\")"
"Let's establish a web API connection to PINO. We need to specify that PINO is a PI server."
]
},
{
"cell_type": "markdown",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"By default, a cache-file using SQLite will be created to store previously read data values [more details](../docs/manual.md#caching-results). The cache can significantly speed up rereading of data, and it is recommended to always keep it enabled. If, for any reason, you want to disable the cache, set it to `None` before making the connection:"
"from tagreader.cache import SmartCache"
]
},
{
Expand All @@ -74,7 +74,7 @@
"metadata": {},
"outputs": [],
"source": [
"c.cache = None"
"c = tagreader.IMSClient(datasource=\"PINO\", imstype=\"piwebapi\", cache=SmartCache)"
]
},
{
Expand Down
Loading