add manual

extra/function/doc/.gitignore

@@ -0,0 +1 @@
+build

extra/function/doc/ja/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -W $(SPHINXOPTS) $(O)

extra/function/doc/ja/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

extra/function/doc/ja/source/acknowledgement.rst

@@ -0,0 +1,4 @@
+謝辞
+=========================================
+
+本ソフトウェアは、科研費(2019-2021年度)「超並列マシンを用いた計算統計と測定技術の融合」および東京大学物性研究所 ソフトウェア高度化プロジェクト (2020, 2021, 2024 年度) の支援を受け開発されました。

extra/function/doc/ja/source/conf.py

@@ -0,0 +1,141 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = '2DMAT solver module: functions'
+copyright = '2020-, 2DMAT developers'
+author = '2DMAT developers'
+
+version = '1.0'
+# The full version, including alpha/beta/rc tags
+release = '1.0-dev'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.mathjax'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The master toctree document.
+master_doc = 'index'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'haiku'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+}
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'ja'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_engine = 'uplatex'
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'userguide_functions_ja.tex', u'2DMAT Function Module Documentation',
+     u'University of Tokyo', 'manual', 'True'),
+]
+
+# latex_docclass =  {'manual': 'jsbook'}
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, '2dmat', u'2DMAT Documentation',
+     author, '2DMAT', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+

extra/function/doc/ja/source/contact.rst

@@ -0,0 +1,22 @@
+お問い合わせ
+=========================================
+
+2DMAT-Functions に関するお問い合わせはこちらにお寄せください。
+
+- バグ報告
+
+  2DMAT-Functions のバグ関連の報告は `GitHubのIssues <https://github.com/issp-center-dev/2DMAT/releases>`_ で受け付けています。
+
+  バグを早期に解決するため、報告時には次のガイドラインに従ってください。
+
+     - 使用している 2DMAT-Functions のバージョンを指定してください。
+
+     - インストールに問題がある場合には、使用しているオペレーティングシステムとコンパイラの情報についてお知らせください。
+
+     - 実行に問題が生じた場合は、実行に使用した入力ファイルとその出力を記載してください。
+
+- その他
+
+  研究に関連するトピックなどGitHubのIssuesで相談しづらいことを問い合わせる際には、以下の連絡先にコンタクトをしてください。
+
+  E-mail: ``2dmat-dev__at__issp.u-tokyo.ac.jp`` (_at_を@に変更してください)

extra/function/doc/ja/source/index.rst

@@ -0,0 +1,23 @@
+.. 2dmat documentation master file, created by
+   sphinx-quickstart on Tue May 26 18:44:52 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to 2DMAT's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction
+   install
+   tutorial/index
+   solver
+   acknowledgement
+   contact
+..
+   usage
+   input
+   output
+   examples

extra/function/doc/ja/source/install.rst

@@ -0,0 +1,72 @@
+インストール
+================================================================
+
+実行環境・必要なパッケージ
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- python 3.6.8 以上
+
+    - 必要なpythonパッケージ
+
+        - tomli (>= 1.2)
+        - numpy (>= 1.14)
+
+- py2dmat version 3.0 以降
+
+
+ダウンロード・インストール
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. py2dmat をインストールする
+
+   - ソースコードからのインストール
+
+     リポジトリから py2dmat のソースファイルを取得します。
+
+     .. code-block:: bash
+
+	$ git clone -b update https://github.com/issp-center-dev/2DMAT.git
+
+     pip コマンドを実行してインストールします。
+
+     .. code-block:: bash
+
+	$ cd 2DMAT
+	$ python3 -m pip install .
+
+
+     ``--user`` オプションを付けるとローカル (``$HOME/.local``) にインストールできます。
+
+     ``python3 -m pip install .[all]`` を実行するとオプションのパッケージも同時にインストールします。
+
+2. py2dmat-functions をインストールする
+
+   - ソースコードからのインストール
+
+     py2dmat-functions のソースファイルは、現在は py2dmat のソースパッケージの extra ディレクトリ内に配置されています。1. に記述した手順に従って py2dmat のソースファイルを取得した後、 ``extra/function`` ディレクトリ内で pip コマンドを実行してインストールします。
+
+     .. code-block:: bash
+
+	$ cd 2DMAT/extra/function
+	$ python3 -m pip install .
+
+     ``--user`` オプションを付けるとローカル (``$HOME/.local``) にインストールできます。
+
+     2DMAT-Functions のライブラリがインストールされます。
+
+
+実行方法
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+2DMAT では順問題ソルバと逆問題解析アルゴリズムを組み合わせて解析を行います。
+2DMAT-Functions に用意された関数の最適化問題の解析を行うには、2DMAT-Functions ライブラリと 2DMAT フレームワークを用いてプログラムを作成し、解析を行います。逆問題解析アルゴリズムは import するモジュールで選択します。プログラム中に入力データの生成を組み込むなど、柔軟な使い方ができます。
+ライブラリの利用方法については以降の章で説明します。
+
+
+アンインストール
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+2DMAT-Functions モジュールおよび 2DMAT モジュールをアンインストールするには、以下のコマンドを実行します。
+
+.. code-block:: bash
+
+    $ python3 -m pip uninstall py2dmat-function py2dmat