MATLAB Online x GitHub で Open & Reusable な研究を
※この投稿は 2023 年 7 月 20 日に The MATLAB blog (Mike Croucher) に投稿されたものの抄訳です。
論文を書いたときに使用した MATLAB コードがあるとします。これをどうやってできるだけ多くの人に使用してもらいますか?
今回はそれが可能になる新しい方法を紹介します。
- ステップ1:MATLAB コードを GitHub にアップロード
- ステップ2:リポジトリを MATLAB Online で開けるリンクを作成します。リンクだけでなくリポジトリにこんなバッジを追加するもできます。
これで、誰かがあなたのコードを実行したり変更したりしたい場合、この「Open in MATLAB Online」をクリックして始めることができます。 多くの場合で MATLAB のライセンスを持っていない方でも使用できる機能です!
私はこの機能を初めて知ったときからブログで公開できるよう進めていました!
この記事はここで終わりにしてもいいのですが、もう少し詳細の追加を提案してくれた同僚もいたので、以下に続きます!
研究で使用した MATLAB コードと Simulink モデルは GitHub に
私は長年 Research Software Engineering community の同僚と共に、研究に使用するソフトウェアの改善に取り組んできました。現代の多くの研究は計算ソフトウェアに依存していることが多いですが、Is your Research Software Correct? という質問を常に同僚に投げかけてきました。そして私のキャリアの大部分は、なるべく多くの人がその質問に「はい」と答えられるように支援することに捧げてきました。
Is your Research Software Correct? では、研究者に対して最初にアドバイスすることの1つは「バージョン管理を使用すること」です。私は git と GitHub を推奨していますが、他のバージョン管理システムでも問題ありません。ただ GitHub の人気を考え、今回紹介したワークフローでは、MathWorks は GitHub を最初のターゲットにしています。
研究コードを GitHub にアップロードすると、それは「公開され」他の人が使用できるようになります。これはオープンサイエンスの実践における非常に重要な最初のステップであり、一度実施すれば、さまざまな機能を追加することができます。まずは ReadMe ファイルや Live Script でのコードのデモから、ユニットテスト、継続的インテグレーション、DOI の取得など、さまざまなことを自由に追加できます。
リポジトリに「Open in MATLAB Online」badge を追加
MATLAB Online はクラウド上で実行される MATLAB のブラウザバージョンであり、昨年 150 万人以上の人々に利用されました。詳細はこちらで読むか、手っ取り早い方法として https://matlab.mathworks.com/ から試してみてください。
GitHub はコードを利用可能にし、MATLAB Online はその利用をより簡単にします。もちろん、ユーザーは GitHub からコードをダウンロードしたり、コマンドラインの git を使用してリポジトリをクローンしたりすることができます。その後、デスクトップ版の MATLAB を使用して研究を行うことができます。
「Open in MATLAB Online」バッジを追加することで、興味を持った人々が試すのをさらに簡単にします。必要なのは、リポジトリの URL に基づいてリンクを作成すること。例えば:
- GitHub の URL:https://github.com/slevin48/liveapp
- MATLAB Onlineで開くためのURL(このウェブページで作成):https://matlab.mathworks.com/open/github/v1?repo=slevin48/liveapp&file=SolarPanelEstimator.mlx
上記のリンクでは、MATLAB Online に入る際に SolarPanelEstimator.mlx ファイルを読み込むようにエンコードされています。
上記のリンクをクリックすると、MATLAB Online が開き、リポジトリがユーザーの MATLAB ドライブにクローンされ、要求されたファイルが開かれます。一連の動作を動画にしたのが以下の gif です。
開かれた Live Script は、Live Controls を使用して作成されたシンプルなもので(必要があれば)その背後にあるコードは、クリックひとつで表示および編集することができます。
どんな公開リポジトリでもワンクリックでいつでもクローン
この新しいワークフローの良いところは、GitHub リポジトリの所有者は MATLAB Online で開くために特に何もする必要がない点です。MATLAB コードを含む GitHub リポジトリを見つけ、リンクを作成して読者、学生、または共同研究者に提供することができます。執筆時点では、Rob Campbell 氏のリポジトリには「Open in MATLAB Online」バッジがありません:
https://github.com/raacampbell/shadedErrorBar
ドキュメントの指示に従って、URLを作成します。
https://matlab.mathworks.com/open/github/v1?repo=raacampbell/shadedErrorBar
これで完了です。または、GitHubリポジトリをこのウェブページに入力するだけで、自動的に処理されます。
もちろん、リポジトリの所有者として、自分のコードを開くためのユーザーの利便性を向上させるために、ReadMeファイルに以下の MarkDown を追加することもできます。
[![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=raacampbell/shadedErrorBar)
こんな badge が表示されるようになります。
MATLAB ライセンスがない?問題ありません
多くの大学や研究機関は MATLAB ライセンスを持っていますが、共同研究者が持っていない場合はどうでしょうか? 彼らはどのようにコードを実行、編集、一般的に操作するのでしょうか? 答えは、彼らがリンクをクリックしてそれを行うだけです。
必要なのは無料の MathWorks アカウントで、MATLAB Online(basic)を利用することができます。確かに制限はあります(詳細はこちらを参照)、しかし多くのことがサポートされています。
リポジトリに「Open in MATLAB Online」を追加しよう!
MATLAB コードを持っていて、それを世界中からアクセス可能にしたい場合は、今すぐ badge をリポジトリに追加です!
- Category:
- Community,
- 機能と使い方
Comments
To leave a comment, please click here to sign in to your MathWorks Account or create a new one.