導入する
NMRLinkは、npmを使うプロジェクトにも、ビルドなしの静的HTMLにも組み込めます。
このページの内容
必要な環境
- 実機測定には、対応する学生実験用NMR装置と、USB接続したPCが必要です。
- 直接接続にはPC版のChrome・Edgeの最新版、またはFirefox 151以降を使います。Safariでは直接接続できません。
- ページはHTTPS、または装置を接続したPCのlocalhostで開きます。HTMLファイルを直接開くfile: URLは使いません。
模擬データでの表示や保存済みデータの解析は、実機なしでも試せます。対応ブラウザと動作確認環境の詳細も確認してください。
導入方法を選ぶ
既存の画面で測定するだけなら、標準Web UIをそのまま利用できます。
npmで導入する
自分のプロジェクトで、次を実行します。
sh
npm install nmrlinkJavaScriptから、必要な機能を読み込みます。
js
import { NMRController, analyzeMeasurement } from "nmrlink";
import { NMRGraphs } from "nmrlink/graphs";
import { saveMeasurement } from "nmrlink/browser";パッケージはES modules形式で、実行時依存パッケージはありません。TypeScript型定義は含みません。
静的HTMLで使う
npmのインストールやビルドは不要です。
- GitHubのCodeメニューからZIPをダウンロードし、展開します。
packages/nmrlink/srcフォルダを、自分の作業フォルダへnmrlinkという名前で丸ごとコピーします。- 同じ作業フォルダに
example.htmlを作ります。
text
my-nmr-ui/
├── example.html
└── nmrlink/ ← packages/nmrlink/src の中身をすべて配置HTMLでは type="module" を指定し、相対URLで読み込みます。
html
<!doctype html>
<html lang="ja">
<head>
<meta charset="utf-8">
<title>NMRLink</title>
</head>
<body>
<script type="module">
import { NMRController, analyzeMeasurement } from "./nmrlink/index.js";
import { NMRGraphs } from "./nmrlink/graphs.js";
import { saveMeasurement } from "./nmrlink/browser.js";
// ここに操作画面と測定処理を追加します。
</script>
</body>
</html>作業フォルダをVS CodeのLive Serverなどで配信し、ブラウザで開きます。ローカルで実機に接続するときはlocalhostを使ってください。
配置を変える場合はimport先も変更します。サンプルのコードを自分のフォルダへ移す場合も同様です。
接続できない場合
Node.jsでの利用はNode.jsから使う、 AIを使った実装はAIと一緒に作るを参照してください。