1. 準備
本ドキュメントのチュートリアル1A~1Dを実行するには、以下の準備が必要です。
intdashサーバー環境の用意
エッジアカウントの作成
認証情報の払い出し
Python実行環境の準備(チュートリアル1C、1D用)
1.1. intdashサーバー環境の用意
まず、intdashサーバー環境を用意し、APIアクセスを受け付けられるようにします。 intdashサーバー環境を用意する方法には、マネージドサービスを契約する、ライセンスを購入し自分で構築する、などの選択肢があります。 別途用意されたドキュメントを参照し、intdashサーバー環境を用意してください。
1.2. エッジアカウントの作成
intdashでは、サーバーとデータをやり取りするノードを「エッジ」と呼びます。 時系列データはあるエッジが生成・取得したデータとして、エッジに紐づけて管理されます。 そのため、CSVファイルをintdashにインポートする場合も、 そのデータが「どのエッジから取得されたものであるか(データの取得元)」を指定してアップロードする必要があります。
このあとのチュートリアルではCSVファイルを edge1
というエッジが取得したデータとして扱います。
そのため、まず、以下の手順で edge1
というエッジアカウントを作成します。
ユーザー名とパスワードでintdashにログインして、My Page(
https://<intdashサーバーのホスト名>/users/me/
)を開きます。[エッジ] > [エッジを作成]をクリックし、
edge1
という名前のエッジアカウントを作成します。UUIDとクライアントシークレットが表示されますが、このチュートリアルシナリオではUUIDとクライアントシークレットをメモしておく必要はありません。
1.3. 認証情報の払い出し
intdashサーバーへアクセスするには、認証情報が必要になります。
Webアプリケーションを使用する際には、サインイン画面からユーザー名とパスワードを使用してサインインできます。 APIを使用する場合は、OAuth2クライアントやAPIトークンなど複数の認証情報を使用することができますが、 本チュートリアルではユーザーのAPIトークンを使用します。
そのため、以下の手順で、お使いのユーザーアカウントにAPIトークンを作成してください。
ユーザー名とパスワードでintdashにログインして、My Page(
https://<intdashサーバーのホスト名>/users/me/
)を開きます。[APIトークン] > [APIトークンを作成]をクリックし、APIトークンを作成します。APIトークン名は任意、有効期限は設定無しで構いません。
チュートリアルの途中で使用するため、画面上に表示されたAPIトークンをメモしておいてください。
1.4. Python実行環境の準備
チュートリアル 1C および 1D では、Pythonプログラムからintdashサーバーにアクセスするため、Pythonの実行環境が必要です。
必要な環境を簡単に準備できる、以下の DockerによるJupyter Notebook実行環境 をおすすめします。
1.4.1. DockerによるJupyter Notebook実行環境
こちらのDockerfile
をダウンロードします。1FROM jupyter/scipy-notebook:2023-05-30 2RUN pip install requests iscp
以下のコマンドを実行してコンテナイメージをビルドします。
docker build -t intdash-sdk-tutorials-env .
以下のコマンドを実行してコンテナを起動します。
docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work intdash-sdk-tutorials-env
コンテナ起動時に表示される以下のURLをウェブブラウザーで開いて、JupyterLab環境にアクセスします。
http://127.0.0.1:8888/lab?token=<起動ごとに変わるトークン文字列>
1.4.2. 上記Dockerコンテナ以外のPython環境
上記Dockerコンテナを使用しない場合は、Python 3.10以上の環境を準備し、PyPIから以下のライブラリーをインストールしてください。
iscp (intdashリアルタイムAPI用クライアント)
requests
pandas
matplotlib