Quarto で Python を使ってみよう！

Quarto

Python

Ubuntu

VSCode

R ユーザーはこれでよくない？

公開

2024年5月8日

最終更新

2024年6月27日

はじめに

注意

この記事は Windows ユーザー向けです。ただ、事前準備が異なるだけで、それ以降は Mac ユーザーの方でも参考になると思います。

Python の環境構築って初心者にはなんだかめんどくさいですよね。私も Python はあまり使わないので、環境構築には苦労しています。

今回はR Markdown に似ているでおなじみ（？）の Quarto を用いた、Python の環境構築の方法をご紹介します。

Anaconda をインストールして Jupiter Notebook を使っている方も多いと思いますが、今回は Anaconda ではなく Quarto で Python を使ってみましょう。

Quarto とは

Quarto は、RStudio のチームが開発している、R Markdown に似たドキュメント作成ツールです。R Markdown は R のためのドキュメント作成ツールですが、Quarto は Python や Julia など他の言語でも使えるようになっています。

Quarto は、RStudio のチームが開発しているため、RStudio との親和性が高いです。RStudio と Quarto を組み合わせて使うことで、R と Python の両方を使ったドキュメント作成が可能になります¹。

事前準備

以前の記事で、Docker を使って環境構築する方法をご紹介しましたが、この記事を最初に読んでいる方に向けて、より簡単な手順で環境構築する方法をご紹介します。

前提

VSCode をインストールしていること
WSL2, Ubuntu をインストールしていること
- Ubuntu はデフォルトで Python がインストールされています。

ここまではそれほど難しくありませんので、まだの方はこちらの記事をご覧ください。

WSL2 に接続

VSCode を起動して、画面左下の >< マークをクリックして、「WSL への接続」を選択します。

Quarto のインストール

画面上部「ターミナル」から「新しいターミナル」を選択²し、ターミナルを開く
以下のコマンドを入力して実行
- URL の部分は最新のものに変えてください。
- Quarto ホームページからプラットフォームが Ubuntu 18+/Debian 10+ であるダウンロードリンクを使用してください。

bash

# Quartoパッケージをダウンロード（URL は適宜更新）
wget https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.554/quarto-1.4.554-linux-amd64.deb

# パッケージをインストール（バージョン部分は適宜変更）
sudo dpkg -i quarto-1.4.554-linux-amd64.deb

Docker を使う場合

Docker を使っている場合は、Dockerfile に以下のコマンドを追加してください。

Dockerfile

RUN wget -O quarto.deb "https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.553/quarto-1.4.553-linux-amd64.deb" && \
    dpkg -i quarto.deb && \
    rm quarto.deb

ちなみに、私の記事で紹介しているテンプレートを使用される場合は、既にこのコマンドが追加されているので、追加する必要はありません。

これで Quarto のインストールは完了です。

拡張機能の準備

拡張機能の検索窓から、次の拡張機能をインストールしてください。

quarto.quarto（Quarto）
ms-python.python（Python）
ms-toolsai.jupyter（Jupyter）

使ってみる

新しい Quarto ファイルを作成

画面左上の「ファイル」から「新しいファイル」を選択、「Quarto Document」を選んで新規ファイルを作成します。
- Ctrl + S でファイルを保存できます。保存する際に任意のフォルダに test.qmd などの名前で保存してください。
yaml ヘッダーを次のように編集します。

YAML ヘッダー

---
title: "タイトル"
author: "著者"
format: html
jupyter: python3
---

以下のようにコードを書いてみましょう。

Quarto

For a demonstration of a line plot on a polar axis, see @fig-polar.

```{python}
#| label: fig-polar
#| fig-cap: "A line plot on a polar axis"

import numpy as np
import matplotlib.pyplot as plt

r = np.arange(0, 2, 0.01)
theta = 2 * np.pi * r
fig, ax = plt.subplots(
  subplot_kw = {'projection': 'polar'} 
)
ax.plot(theta, r)
ax.set_rticks([0.5, 1, 1.5, 2])
ax.grid(True)
plt.show()
```

パッケージのインストール
- 今回、numpy と matplotlib を使っているので、はじめにこれらをインストールしないとエラーが出ます。
- また、実行する際に ModuleNotFoundError: が出たら、そのモジュールもインストールする必要があります³。
- ターミナルから以下のコマンドを実行してください。

bash

pip install numpy matplotlib nbformat nbclient

実行
- 画面右上のボタンの中から「Preview」を選択して、ファイルをレンダリングします。

R を使うときと同様に、Python のコードを書いて実行することができました。

ちなみに

R ユーザーの私としては、エンジンは R Markdown と同じ Knitr を使っているので、基本的に R 環境に Python を混ぜるということになります。

そのままでは R と Python が混在したコードは出力できません⁴が、reticulate パッケージを使うことで R を使っていても Python が混ざったコードを出力できます。

例えばこの記事は R 環境で書いていますのでこのままでは Python を使えません。そこで reticulate パッケージをインストールします。

install.packages('reticulate')

ライブラリで読み込む必要はありません。

先ほどのコードを書いてみると、

import numpy as np
import matplotlib.pyplot as plt

r = np.arange(0, 2, 0.01)
theta = 2 * np.pi * r
fig, ax = plt.subplots(
  subplot_kw = {'projection': 'polar'} 
)
ax.plot(theta, r)
ax.set_rticks([0.5, 1, 1.5, 2])
ax.grid(True)
plt.show()

無事図 1 が出力できました。

このように R と Python が混在していても出力できますので、必要に応じて使ってみてください。

まとめ

今回は Quarto を使って Python の環境構築を行いました。

Anaconda と比べると、Quarto はより柔軟で、R でも Python でも使えるのがメリットです。

また、書き方はほぼ R Markdown と同じなので、普段 R を使っている方にはすぐに慣れると思います。

ただし、R と Python を1つのファイルで併用する際には追加でパッケージのインストールが必要です。

以上です。お疲れ様でした！

追記

2024年5月16日：R と Python が混在したコードの出力について追加

注

今回は Python がメインなので RStudio は使いませんが、普段 R を使う方はぜひ RStudio でも使ってみてください。↩︎
ショートカット：Ctrl + Shift + @↩︎
今回は nbformat と nbclient が出ると思います。↩︎
R では Knitr を使って Python では Jupyter を使うためです。↩︎

--- title: "Quarto で Python を使ってみよう！" description: | R ユーザーはこれでよくない？ date: 2024-05-08 date-modified: last-modified categories: - Quarto - Python - Ubuntu - VSCode - R --- # はじめに ::: {.callout-important title="注意"} この記事は Windows ユーザー向けです。ただ、事前準備が異なるだけで、それ以降は Mac ユーザーの方でも参考になると思います。 ::: Python の環境構築って初心者にはなんだかめんどくさいですよね。私も Python はあまり使わないので、環境構築には苦労しています。今回はR Markdown に似ているでおなじみ（？）の Quarto を用いた、Python の環境構築の方法をご紹介します。 Anaconda をインストールして Jupiter Notebook を使っている方も多いと思いますが、今回は Anaconda ではなく Quarto で Python を使ってみましょう。 # Quarto とは Quarto は、RStudio のチームが開発している、R Markdown に似たドキュメント作成ツールです。R Markdown は R のためのドキュメント作成ツールですが、Quarto は Python や Julia など他の言語でも使えるようになっています。 Quarto は、RStudio のチームが開発しているため、RStudio との親和性が高いです。RStudio と Quarto を組み合わせて使うことで、R と Python の両方を使ったドキュメント作成が可能になります^[今回は Python がメインなので RStudio は使いませんが、普段 R を使う方はぜひ RStudio でも使ってみてください。]。 # 事前準備 [以前の記事](https://yo5uke.github.io/tips/240504_container/)で、Docker を使って環境構築する方法をご紹介しましたが、この記事を最初に読んでいる方に向けて、より簡単な手順で環境構築する方法をご紹介します。 ## 前提 - VSCode をインストールしていること - WSL2, Ubuntu をインストールしていること - Ubuntu はデフォルトで Python がインストールされています。ここまではそれほど難しくありませんので、まだの方は[こちらの記事](https://yo5uke.github.io/tips/240504_container/)をご覧ください。 ## WSL2 に接続 VSCode を起動して、画面左下の `><` マークをクリックして、「WSL への接続」を選択します。 ![WSL2 に接続](image/vscode-wsl.png) ## Quarto のインストール 1. 画面上部「ターミナル」から「新しいターミナル」を選択^[ショートカット：`Ctrl` + `Shift` + `@`]し、ターミナルを開く 2. 以下のコマンドを入力して実行 - URL の部分は最新のものに変えてください。 - [Quarto ホームページ](https://quarto.org/docs/get-started/)からプラットフォームが `Ubuntu 18+/Debian 10+` であるダウンロードリンクを使用してください。 ```{.bash filename="bash"} # Quartoパッケージをダウンロード（URL は適宜更新） wget https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.554/quarto-1.4.554-linux-amd64.deb # パッケージをインストール（バージョン部分は適宜変更） sudo dpkg -i quarto-1.4.554-linux-amd64.deb ``` ::: {.callout-tip title="Docker を使う場合" collapse="true"} Docker を使っている場合は、Dockerfile に以下のコマンドを追加してください。 ```{.bash filename="Dockerfile"} RUN wget -O quarto.deb "https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.553/quarto-1.4.553-linux-amd64.deb" && \ dpkg -i quarto.deb && \ rm quarto.deb ``` ちなみに、[私の記事](https://yo5uke.github.io/tips/240504_container/)で紹介しているテンプレートを使用される場合は、既にこのコマンドが追加されているので、追加する必要はありません。 ::: これで Quarto のインストールは完了です。 ## 拡張機能の準備拡張機能の検索窓から、次の拡張機能をインストールしてください。 - `quarto.quarto`（Quarto） - `ms-python.python`（Python） - `ms-toolsai.jupyter`（Jupyter） # 使ってみる ## 新しい Quarto ファイルを作成 1. 画面左上の「ファイル」から「新しいファイル」を選択、「Quarto Document」を選んで新規ファイルを作成します。 - `Ctrl` + `S` でファイルを保存できます。保存する際に任意のフォルダに `test.qmd` などの名前で保存してください。 2. yaml ヘッダーを次のように編集します。 ```{.yml filename="YAML ヘッダー"} --- title: "タイトル" author: "著者" format: html jupyter: python3 --- ``` 3. 以下のようにコードを書いてみましょう。 ````{.markdown filename="Quarto"} For a demonstration of a line plot on a polar axis, see @fig-polar. ```{python} #| label: fig-polar #| fig-cap: "A line plot on a polar axis" import numpy as np import matplotlib.pyplot as plt r = np.arange(0, 2, 0.01) theta = 2 * np.pi * r fig, ax = plt.subplots( subplot_kw = {'projection': 'polar'} ) ax.plot(theta, r) ax.set_rticks([0.5, 1, 1.5, 2]) ax.grid(True) plt.show() ``` ```` 4. パッケージのインストール - 今回、`numpy` と `matplotlib` を使っているので、はじめにこれらをインストールしないとエラーが出ます。 - また、実行する際に `ModuleNotFoundError:` が出たら、そのモジュールもインストールする必要があります^[今回は `nbformat` と `nbclient` が出ると思います。]。 - ターミナルから以下のコマンドを実行してください。 ```{.bash filename="bash"} pip install numpy matplotlib nbformat nbclient ``` 5. 実行 - 画面右上のボタンの中から「Preview」を選択して、ファイルをレンダリングします。 ![実行結果](image/python.png) R を使うときと同様に、Python のコードを書いて実行することができました。 # ちなみに R ユーザーの私としては、エンジンは R Markdown と同じ `Knitr` を使っているので、基本的に R 環境に Python を混ぜるということになります。そのままでは R と Python が混在したコードは出力できません^[R では `Knitr` を使って Python では `Jupyter` を使うためです。]が、`reticulate` パッケージを使うことで R を使っていても Python が混ざったコードを出力できます。例えばこの記事は R 環境で書いていますのでこのままでは Python を使えません。そこで `reticulate` パッケージをインストールします。 ```{.r filename="R"} install.packages('reticulate') ``` ライブラリで読み込む必要はありません。先ほどのコードを書いてみると、 ```{python} #| label: fig-polar #| fig-cap: "A line plot on a polar axis" import numpy as np import matplotlib.pyplot as plt r = np.arange(0, 2, 0.01) theta = 2 * np.pi * r fig, ax = plt.subplots( subplot_kw = {'projection': 'polar'} ) ax.plot(theta, r) ax.set_rticks([0.5, 1, 1.5, 2]) ax.grid(True) plt.show() ``` 無事 @fig-polar が出力できました。このように R と Python が混在していても出力できますので、必要に応じて使ってみてください。 # まとめ今回は Quarto を使って Python の環境構築を行いました。 Anaconda と比べると、Quarto はより柔軟で、R でも Python でも使えるのがメリットです。また、書き方はほぼ R Markdown と同じなので、普段 R を使っている方にはすぐに慣れると思います。ただし、R と Python を1つのファイルで併用する際には追加でパッケージのインストールが必要です。以上です。お疲れ様でした！ # 追記 2024年5月16日：R と Python が混在したコードの出力について追加