Python を使ったデータ分析や視覚化を気軽に試せるように、コンテナを使ってローカル開発環境を構築してみます。

Jupyter Notebook で Python を書くためのコンテナ開発環境を作成する

<p>Python を使ったデータ分析や視覚化を気軽に試せるように、コンテナを使ってローカル開発環境を構築してみます。</p>
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#jupyter-notebook">Jupyter Notebook</a></li>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#dockerfile">Dockerfile</a></li>
<li><a href="#docker-composeyml">docker-compose.yml</a></li>
<li><a href="#%E3%82%B0%E3%83%A9%E3%83%95%E3%81%AE%E6%97%A5%E6%9C%AC%E8%AA%9E%E5%8C%96">グラフの日本語化</a></li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a></li>
</ol>
<h2 id="jupyter-notebook">Jupyter Notebook</h2>
<p>Jupyter Notebook は、ブラウザ上で Python を記述して実行することができる web ベースの開発環境です。（言語については Python に限らない）</p>
<p><a href="https://jupyter.org/" target="_blank" rel="noopener noreferrer">https://jupyter.org/</a></p>
<h2 id="開発環境">開発環境</h2>
<p>コンテナで環境を作成するので、Docker が入っている前提です。</p>
<ul>
<li>Docker for Mac 4.1.0
<ul>
<li>Docker 20.10.8</li>
<li>Compose 1.29.2</li>
</ul>
</li>
</ul>
<p>また、最終的なディレクトリ・ファイル構成は以下になります。</p>
<pre><code class="hljs language-shell">.
├── Dockerfile
├── config
│   └── matplotlibrc
└───docker-compose.yml

</code></pre>
<p>これから上記 3 つのファイルを作成していきます。</p>
<h2 id="dockerfile">Dockerfile</h2>
<p>まずは Dockerfile を作成してイメージを定義します。</p>
<dl class="description_setting">
<dt>Dockerfile</dt>
<dd>
<pre><code class="hljs language-dockerfile">FROM python:3.9.7-buster

RUN apt-get update
RUN apt install -y locales &#x26;&#x26; localedef -f UTF-8 -i ja_JP ja_JP.UTF-8
ENV LANG ja_JP.UTF-8
ENV LANGUAGE ja_JP:ja
ENV LC_ALL ja_JP.UTF-8
ENV TZ JST-9

# 日本語 font のインストール
RUN apt-get install -y fonts-noto-cjk

# python ライブラリのインストール
RUN python -m pip install pandas
RUN python -m pip install numpy
RUN python -m pip install matplotlib
RUN python -m pip install jupyterlab
RUN python -m pip install notebook
</code></pre>
</dd>
</dl>
<ul>
<li>Jupyter Notebook を日本語で使いたいので、locales を入れて言語の設定を行なっています。</li>
<li>グラフ描画の際に、タイトルや凡例を日本語で表示させたいので、日本語のフォントをインストールしています。</li>
<li>最後に記述されている Python ライブラリのインストールは、必要最低限だけ記述してあります。</li>
</ul>
<p>なお、私は Debian や Python に関しては弱者なのでイメージに buster を選択しています。この辺に詳しい場合は、適宜最適なイメージを指定すると良いと思います。</p>
<h2 id="docker-composeyml">docker-compose.yml</h2>
<p>次に、docker-compose.yml を作成します。</p>
<dl class="description_setting">
<dt>docker-compose.yml</dt>
<dd>
<pre><code class="hljs language-yaml"><span class="hljs-attr">version:</span> <span class="hljs-string">'3'</span>
<span class="hljs-attr">services:</span>
  <span class="hljs-attr">python3:</span>
    <span class="hljs-attr">build:</span> <span class="hljs-string">.</span>
    <span class="hljs-attr">container_name:</span> <span class="hljs-string">python3</span>
    <span class="hljs-attr">working_dir:</span> <span class="hljs-string">/root/opt</span>
    <span class="hljs-attr">tty:</span> <span class="hljs-literal">true</span>
    <span class="hljs-attr">volumes:</span>
      <span class="hljs-bullet">-</span> <span class="hljs-string">./src:/root/opt</span>
      <span class="hljs-bullet">-</span> <span class="hljs-string">./config:/root/.config/matplotlib</span>
    <span class="hljs-attr">ports:</span>
      <span class="hljs-bullet">-</span> <span class="hljs-string">"8888:8888"</span>
</code></pre>
</dd>
</dl>
<p>volumes には、以下の 2 つを指定しつなげています。</p>
<ul>
<li>Jupyter Notebook で作成したファイルやデータを設置するための src ディレクトリ</li>
<li>matplotlib の設定ファイルを設置するディレクトリ</li>
</ul>
<h2 id="グラフの日本語化">グラフの日本語化</h2>
<p>解析結果をチャートに描画する際に、タイトルや凡例などに日本語を使いたい場合はデフォルトのフォントだと日本語が無く文字化けしてしまいます。 イメージ作成の際に日本語フォントをインストールしたので、それを設定ファイルに指定して、日本語が表示されるようにしてやります。</p>
<dl class="description_setting">
<dt>config/matplotlibrc</dt>
<dd>
<pre><code class="hljs language-shell">font.family:  Noto Sans CJK JP
</code></pre>
</dd>
</dl>
<h2 id="動作確認">動作確認</h2>
<p>設定が終わったので、以下のコマンドを順に流してコンテナを作成します。</p>
<pre><code class="hljs language-shell"><span class="hljs-meta prompt_"># </span><span class="bash">1. イメージ作成</span>
docker compose build
<span class="hljs-meta prompt_">
# </span><span class="bash">2. コンテナ起動</span>
docker compose up -d
</code></pre>
<p>コンテナが起動したら、以下のコマンドで Jupyter Notebook を起動します。</p>
<pre><code class="hljs language-shell"><span class="hljs-meta prompt_"># </span><span class="bash">Jupyter Notebook 起動</span>
docker compose exec python3 jupyter notebook --allow-root --ip=0.0.0.0
</code></pre>
<p>コマンドを実行すると、以下のように URL が出力されます。</p>
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/231/wQAGrcIXrcbFwQTCmM8m.png" width="800" height="183" alt="Jupyter Notebook 起動後に URL が表示される"></div>
<p>出力された URL にアクセスすれば、Jupyter Notebook を使い始めることができます。</p>
<div class="img_wrap"><amp-img layout="responsive" src="/images/posts/231/tH6scla2Kq8CgFHdTztM.png" width="1200" height="629" alt="Jupyter Notebook で Python を使ったデータ分析をローカルで試すことができる"></div>
<h2 id="まとめ">まとめ</h2>
<p>データを統計解析してみたりそれをグラフなどで視覚化してみようと思った時に、ローカル環境でその全てを実現しようとすると Python 初心者にはなかなか難しいですが、Jupyter Notebook の環境を作れば簡単にその両方を叶えられるので、統計を学習したりする場合には手早くできてとても便利なのでオススメです。</p>

<p>Python を使ったデータ分析や視覚化を気軽に試せるように、コンテナを使ってローカル開発環境を構築してみます。</p>
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#jupyter-notebook">Jupyter Notebook</a></li>
<li><a href="#%E9%96%8B%E7%99%BA%E7%92%B0%E5%A2%83">開発環境</a></li>
<li><a href="#dockerfile">Dockerfile</a></li>
<li><a href="#docker-composeyml">docker-compose.yml</a></li>
<li><a href="#%E3%82%B0%E3%83%A9%E3%83%95%E3%81%AE%E6%97%A5%E6%9C%AC%E8%AA%9E%E5%8C%96">グラフの日本語化</a></li>
<li><a href="#%E5%8B%95%E4%BD%9C%E7%A2%BA%E8%AA%8D">動作確認</a></li>
</ol>
<h2 id="jupyter-notebook">Jupyter Notebook</h2>
<p>Jupyter Notebook は、ブラウザ上で Python を記述して実行することができる web ベースの開発環境です。（言語については Python に限らない）</p>
<p><a href="https://jupyter.org/" target="_blank" rel="noopener noreferrer">https://jupyter.org/</a></p>
<h2 id="開発環境">開発環境</h2>
<p>コンテナで環境を作成するので、Docker が入っている前提です。</p>
<ul>
<li>Docker for Mac 4.1.0
<ul>
<li>Docker 20.10.8</li>
<li>Compose 1.29.2</li>
</ul>
</li>
</ul>
<p>また、最終的なディレクトリ・ファイル構成は以下になります。</p>
<pre><code class="hljs language-shell">.
├── Dockerfile
├── config
│   └── matplotlibrc
└───docker-compose.yml

</code></pre>
<p>これから上記 3 つのファイルを作成していきます。</p>
<h2 id="dockerfile">Dockerfile</h2>
<p>まずは Dockerfile を作成してイメージを定義します。</p>
<dl class="description_setting">
<dt>Dockerfile</dt>
<dd>
<pre><code class="hljs language-dockerfile">FROM python:3.9.7-buster

RUN apt-get update
RUN apt install -y locales &#x26;&#x26; localedef -f UTF-8 -i ja_JP ja_JP.UTF-8
ENV LANG ja_JP.UTF-8
ENV LANGUAGE ja_JP:ja
ENV LC_ALL ja_JP.UTF-8
ENV TZ JST-9

# 日本語 font のインストール
RUN apt-get install -y fonts-noto-cjk

# python ライブラリのインストール
RUN python -m pip install pandas
RUN python -m pip install numpy
RUN python -m pip install matplotlib
RUN python -m pip install jupyterlab
RUN python -m pip install notebook
</code></pre>
</dd>
</dl>
<ul>
<li>Jupyter Notebook を日本語で使いたいので、locales を入れて言語の設定を行なっています。</li>
<li>グラフ描画の際に、タイトルや凡例を日本語で表示させたいので、日本語のフォントをインストールしています。</li>
<li>最後に記述されている Python ライブラリのインストールは、必要最低限だけ記述してあります。</li>
</ul>
<p>なお、私は Debian や Python に関しては弱者なのでイメージに buster を選択しています。この辺に詳しい場合は、適宜最適なイメージを指定すると良いと思います。</p>
<h2 id="docker-composeyml">docker-compose.yml</h2>
<p>次に、docker-compose.yml を作成します。</p>
<dl class="description_setting">
<dt>docker-compose.yml</dt>
<dd>
<pre><code class="hljs language-yaml"><span class="hljs-attr">version:</span> <span class="hljs-string">'3'</span>
<span class="hljs-attr">services:</span>
  <span class="hljs-attr">python3:</span>
    <span class="hljs-attr">build:</span> <span class="hljs-string">.</span>
    <span class="hljs-attr">container_name:</span> <span class="hljs-string">python3</span>
    <span class="hljs-attr">working_dir:</span> <span class="hljs-string">/root/opt</span>
    <span class="hljs-attr">tty:</span> <span class="hljs-literal">true</span>
    <span class="hljs-attr">volumes:</span>
      <span class="hljs-bullet">-</span> <span class="hljs-string">./src:/root/opt</span>
      <span class="hljs-bullet">-</span> <span class="hljs-string">./config:/root/.config/matplotlib</span>
    <span class="hljs-attr">ports:</span>
      <span class="hljs-bullet">-</span> <span class="hljs-string">"8888:8888"</span>
</code></pre>
</dd>
</dl>
<p>volumes には、以下の 2 つを指定しつなげています。</p>
<ul>
<li>Jupyter Notebook で作成したファイルやデータを設置するための src ディレクトリ</li>
<li>matplotlib の設定ファイルを設置するディレクトリ</li>
</ul>
<h2 id="グラフの日本語化">グラフの日本語化</h2>
<p>解析結果をチャートに描画する際に、タイトルや凡例などに日本語を使いたい場合はデフォルトのフォントだと日本語が無く文字化けしてしまいます。 イメージ作成の際に日本語フォントをインストールしたので、それを設定ファイルに指定して、日本語が表示されるようにしてやります。</p>
<dl class="description_setting">
<dt>config/matplotlibrc</dt>
<dd>
<pre><code class="hljs language-shell">font.family:  Noto Sans CJK JP
</code></pre>
</dd>
</dl>
<h2 id="動作確認">動作確認</h2>
<p>設定が終わったので、以下のコマンドを順に流してコンテナを作成します。</p>
<pre><code class="hljs language-shell"><span class="hljs-meta prompt_"># </span><span class="bash">1. イメージ作成</span>
docker compose build
<span class="hljs-meta prompt_">
# </span><span class="bash">2. コンテナ起動</span>
docker compose up -d
</code></pre>
<p>コンテナが起動したら、以下のコマンドで Jupyter Notebook を起動します。</p>
<pre><code class="hljs language-shell"><span class="hljs-meta prompt_"># </span><span class="bash">Jupyter Notebook 起動</span>
docker compose exec python3 jupyter notebook --allow-root --ip=0.0.0.0
</code></pre>
<p>コマンドを実行すると、以下のように URL が出力されます。</p>
<div class="img_wrap"><img src="/images/posts/231/wQAGrcIXrcbFwQTCmM8m.png" width="800" height="183" alt="Jupyter Notebook 起動後に URL が表示される"></div>
<p>出力された URL にアクセスすれば、Jupyter Notebook を使い始めることができます。</p>
<div class="img_wrap"><img src="/images/posts/231/tH6scla2Kq8CgFHdTztM.png" width="1200" height="629" alt="Jupyter Notebook で Python を使ったデータ分析をローカルで試すことができる"></div>
<h2 id="まとめ">まとめ</h2>
<p>データを統計解析してみたりそれをグラフなどで視覚化してみようと思った時に、ローカル環境でその全てを実現しようとすると Python 初心者にはなかなか難しいですが、Jupyter Notebook の環境を作れば簡単にその両方を叶えられるので、統計を学習したりする場合には手早くできてとても便利なのでオススメです。</p>

Author