Skip to content

Commit

Permalink
Deploy docs to main by GitHub Actions triggered by 4a61849
Browse files Browse the repository at this point in the history
  • Loading branch information
ODAT-SE Developers committed Oct 31, 2024
1 parent 072b078 commit 73a272f
Show file tree
Hide file tree
Showing 33 changed files with 152 additions and 345 deletions.
20 changes: 5 additions & 15 deletions manual/main/api/_modules/odatse/_info.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,23 +69,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse._info</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>

<span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">MutableMapping</span><span class="p">,</span> <span class="n">Optional</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
Expand Down
10 changes: 9 additions & 1 deletion manual/main/api/_modules/odatse/_initialize.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,15 @@
<div itemprop="articleBody">

<h1>Source code for odatse._initialize</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">odatse</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">import</span> <span class="nn">odatse</span>

<div class="viewcode-block" id="initialize">
<a class="viewcode-back" href="../../odatse._initialize.html#odatse._initialize.initialize">[docs]</a>
Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/_main.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse._main</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">odatse</span>
Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/algorithm.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,21 +69,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">from</span> <span class="nn">._algorithm</span> <span class="kn">import</span> <span class="n">AlgorithmBase</span>

Expand Down
20 changes: 5 additions & 15 deletions manual/main/api/_modules/odatse/algorithm/_algorithm.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,23 +70,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm._algorithm</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>

<span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>


<span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABCMeta</span><span class="p">,</span> <span class="n">abstractmethod</span>
Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/algorithm/bayes.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm.bayes</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
<span class="kn">import</span> <span class="nn">time</span>
Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/algorithm/exchange.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm.exchange</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="nb">open</span>
<span class="kn">import</span> <span class="nn">copy</span>
Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/algorithm/mapper_mpi.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm.mapper_mpi</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">Dict</span>

Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/algorithm/min_search.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm.min_search</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Union</span>
<span class="kn">import</span> <span class="nn">time</span>
Expand Down
18 changes: 5 additions & 13 deletions manual/main/api/_modules/odatse/algorithm/montecarlo.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,13 @@
<div itemprop="articleBody">

<h1>Source code for odatse.algorithm.montecarlo</h1><div class="highlight"><pre>
<span></span><span class="c1"># 2DMAT -- Data-analysis software of quantum beam diffraction experiments for 2D material structure</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span></span><span class="c1"># SPDX-License-Identifier: MPL-2.0</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1"># ODAT-SE -- an open framework for data analysis</span>
<span class="c1"># Copyright (C) 2020- The University of Tokyo</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see http://www.gnu.org/licenses/.</span>
<span class="c1"># This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.</span>
<span class="c1"># If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span>

<span class="kn">import</span> <span class="nn">typing</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TextIO</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Tuple</span>
Expand Down
Loading

0 comments on commit 73a272f

Please sign in to comment.