Deploy docs to develop by GitHub Actions triggered by 02d1243

issp-center-dev · Jan 30, 2025 · e15262c · e15262c
1 parent 0d76670
commit e15262c
Show file tree

Hide file tree

Showing 202 changed files with 842 additions and 470 deletions.
diff --git a/manual/develop/en/.buildinfo b/manual/develop/en/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0fe31368b1d5d93aa38fd14080e880b1
+config: 8dc6ba884dcd1e8d9126176ddc01e456
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/manual/develop/en/_modules/index.html b/manual/develop/en/_modules/index.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>Overview: module code &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../_static/doctools.js?v=9bcbadda"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

diff --git a/manual/develop/en/_modules/physbo/blm/basis/fourier.html b/manual/develop/en/_modules/physbo/blm/basis/fourier.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.basis.fourier &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.basis.fourier &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

diff --git a/manual/develop/en/_modules/physbo/blm/core/model.html b/manual/develop/en/_modules/physbo/blm/core/model.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.core.model &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.core.model &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -321,6 +321,8 @@ <h1>Source code for physbo.blm.core.model</h1><div class="highlight"><pre>
 <span class="sd">        Returns</span>
 <span class="sd">        =======</span>
 <span class="sd">        numpy.ndarray</span>
+<span class="sd">            Returned shape is (num_points) if diag=true, (num_points, num_points) if diag=false,</span>
+<span class="sd">            where num_points is the number of points in X.</span>
 
 <span class="sd">        See also</span>
 <span class="sd">        ========</span>

diff --git a/manual/develop/en/_modules/physbo/blm/inf/exact.html b/manual/develop/en/_modules/physbo/blm/inf/exact.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.inf.exact &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.inf.exact &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -265,6 +265,8 @@ <h1>Source code for physbo.blm.inf.exact</h1><div class="highlight"><pre>
 <span class="sd">    Returns</span>
 <span class="sd">    =======</span>
 <span class="sd">    numpy.ndarray</span>
+<span class="sd">        Returned shape is (num_points) if diag=true, (num_points, num_points) if diag=false,</span>
+<span class="sd">        where num_points is the number of points in X.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">Psi</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">Psi</span> <span class="o">=</span> <span class="n">blm</span><span class="o">.</span><span class="n">lik</span><span class="o">.</span><span class="n">linear</span><span class="o">.</span><span class="n">basis</span><span class="o">.</span><span class="n">get_basis</span><span class="p">(</span><span class="n">X</span><span class="p">)</span>

diff --git a/manual/develop/en/_modules/physbo/blm/lik/gauss.html b/manual/develop/en/_modules/physbo/blm/lik/gauss.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.lik.gauss &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.lik.gauss &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

diff --git a/manual/develop/en/_modules/physbo/blm/lik/linear.html b/manual/develop/en/_modules/physbo/blm/lik/linear.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.lik.linear &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.lik.linear &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

diff --git a/manual/develop/en/_modules/physbo/blm/predictor.html b/manual/develop/en/_modules/physbo/blm/predictor.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.predictor &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.predictor &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -195,6 +195,8 @@ <h1>Source code for physbo.blm.predictor</h1><div class="highlight"><pre>
 <span class="sd">        Returns</span>
 <span class="sd">        =======</span>
 <span class="sd">        numpy.ndarray</span>
+<span class="sd">            Returned shape is (num_points),</span>
+<span class="sd">            where num_points is the number of points in test.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">blm</span><span class="o">.</span><span class="n">stats</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">training</span><span class="p">)</span>
@@ -213,10 +215,13 @@ <h1>Source code for physbo.blm.predictor</h1><div class="highlight"><pre>
 <span class="sd">            training dataset. If already trained, the model does not use this.</span>
 <span class="sd">        test: physbo.variable</span>
 <span class="sd">            inputs</span>
-
+<span class="sd">        diag: bool</span>
+<span class="sd">            If true, only variances (diagonal elements) are returned.</span>
 <span class="sd">        Returns</span>
 <span class="sd">        =======</span>
 <span class="sd">        numpy.ndarray</span>
+<span class="sd">            Returned shape is (num_points) if diag=true, (num_points, num_points) if diag=false,</span>
+<span class="sd">            where num_points is the number of points in test.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">blm</span><span class="o">.</span><span class="n">stats</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">training</span><span class="p">)</span>

diff --git a/manual/develop/en/_modules/physbo/blm/prior/gauss.html b/manual/develop/en/_modules/physbo/blm/prior/gauss.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.blm.prior.gauss &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.blm.prior.gauss &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

diff --git a/manual/develop/en/_modules/physbo/gp/core/learning.html b/manual/develop/en/_modules/physbo/gp/core/learning.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.gp.core.learning &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.gp.core.learning &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

diff --git a/manual/develop/en/_modules/physbo/gp/core/model.html b/manual/develop/en/_modules/physbo/gp/core/model.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.gp.core.model &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.gp.core.model &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -381,11 +381,13 @@ <h1>Source code for physbo.gp.core.model</h1><div class="highlight"><pre>
 <span class="sd">        params: numpy.ndarray</span>
 <span class="sd">            Parameters</span>
 <span class="sd">        diag: bool</span>
-<span class="sd">            If X is the diagonalization matrix, true.</span>
+<span class="sd">            If true, only variances (diagonal elements) are returned.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
-<span class="sd">        physbo.gp.inf.exact.get_post_fcov</span>
+<span class="sd">        numpy.ndarray</span>
+<span class="sd">            Returned shape is (num_points) if diag=true, (num_points, num_points) if diag=false,</span>
+<span class="sd">            where num_points is the number of points in X.</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/manual/develop/en/_modules/physbo/gp/core/prior.html b/manual/develop/en/_modules/physbo/gp/core/prior.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>physbo.gp.core.prior &mdash; PHYSBO 2.1-dev documentation</title>
+  <title>physbo.gp.core.prior &mdash; PHYSBO 2.2-dev documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../../../../_static/documentation_options.js?v=6fddfc0f"></script>
+      <script src="../../../../_static/documentation_options.js?v=b33cbb84"></script>
       <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
       <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -99,7 +99,7 @@ <h1>Source code for physbo.gp.core.prior</h1><div class="highlight"><pre>
 <span class="sd">        ----------</span>
 <span class="sd">        mean: numpy.ndarray</span>
 <span class="sd">            mean values of prior</span>
-<span class="sd">        cov: numpy.ndarray</span>
+<span class="sd">        cov: physbo.gp.cov.gauss</span>
 <span class="sd">            covariance matrix of priors</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">mean</span> <span class="o">=</span> <span class="n">mean</span>
@@ -185,10 +185,13 @@ <h1>Source code for physbo.gp.core.prior</h1><div class="highlight"><pre>
 <span class="sd">        params: numpy.ndarray</span>
 <span class="sd">           Parameters.</span>
 <span class="sd">        diag: bool</span>
-<span class="sd">            If X is the diagonalization matrix, true.</span>
+<span class="sd">            If true, only variances (diagonal elements) are returned.</span>
+
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        numpy.ndarray</span>
+<span class="sd">            Returned shape is (num_points) if diag=true, (num_points, num_points) if diag=false,</span>
+<span class="sd">            where num_points is the number of points in X.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
             <span class="n">params</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">)</span>