deploy: 423f21f

Ameyanagi · Jan 8, 2024 · 40c136f · 40c136f
commit 40c136f
Show file tree

Hide file tree

Showing 147 changed files with 18,636 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f91a651cb0694f4ce6275cbcec1c211e
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/authors.doctree b/.doctrees/authors.doctree
diff --git a/.doctrees/contributing.doctree b/.doctrees/contributing.doctree
diff --git a/.doctrees/decomnano.doctree b/.doctrees/decomnano.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/history.doctree b/.doctrees/history.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree
diff --git a/.doctrees/readme.doctree b/.doctrees/readme.doctree
diff --git a/.doctrees/usage.doctree b/.doctrees/usage.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/decomnano/cli.html b/_modules/decomnano/cli.html
diff --git a/_modules/decomnano/decomnano.html b/_modules/decomnano/decomnano.html
diff --git a/_modules/decomnano/sweep.html b/_modules/decomnano/sweep.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,114 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; DecomNano 0.1.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <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=01f34227"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            DecomNano
+          </a>
+              <div class="version">
+                0.1.0
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../readme.html">DecomNano</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">decomnano</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../authors.html">Credits</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../history.html">History</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">DecomNano</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="decomnano/cli.html">decomnano.cli</a></li>
+<li><a href="decomnano/decomnano.html">decomnano.decomnano</a></li>
+<li><a href="decomnano/sweep.html">decomnano.sweep</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Ryuichi Shimogawa.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/authors.rst.txt b/_sources/authors.rst.txt
@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst
diff --git a/_sources/contributing.rst.txt b/_sources/contributing.rst.txt
@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst
diff --git a/_sources/decomnano.rst.txt b/_sources/decomnano.rst.txt
@@ -0,0 +1,37 @@
+decomnano package
+=================
+
+Submodules
+----------
+
+decomnano.cli module
+--------------------
+
+.. automodule:: decomnano.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+decomnano.decomnano module
+--------------------------
+
+.. automodule:: decomnano.decomnano
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+decomnano.sweep module
+----------------------
+
+.. automodule:: decomnano.sweep
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: decomnano
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/history.rst.txt b/_sources/history.rst.txt
@@ -0,0 +1 @@
+.. include:: ../HISTORY.rst
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,20 @@
+Welcome to DecomNano's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme
+   installation
+   usage
+   modules
+   contributing
+   authors
+   history
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/_sources/installation.rst.txt b/_sources/installation.rst.txt
@@ -0,0 +1,51 @@
+.. highlight:: shell
+
+============
+Installation
+============
+
+
+Stable release
+--------------
+
+To install DecomNano, run this command in your terminal:
+
+.. code-block:: console
+
+    $ pip install decomnano
+
+This is the preferred method to install DecomNano, as it will always install the most recent stable release.
+
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
+
+.. _pip: https://pip.pypa.io
+.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
+
+
+From sources
+------------
+
+The sources for DecomNano can be downloaded from the `Github repo`_.
+
+You can either clone the public repository:
+
+.. code-block:: console
+
+    $ git clone git://github.com/Ameyanagi/decomnano
+
+Or download the `tarball`_:
+
+.. code-block:: console
+
+    $ curl -OJL https://github.com/Ameyanagi/decomnano/tarball/master
+
+Once you have a copy of the source, you can install it with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+
+.. _Github repo: https://github.com/Ameyanagi/decomnano
+.. _tarball: https://github.com/Ameyanagi/decomnano/tarball/master
diff --git a/_sources/modules.rst.txt b/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+decomnano
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   decomnano
diff --git a/_sources/readme.rst.txt b/_sources/readme.rst.txt
@@ -0,0 +1 @@
+.. include:: ../README.rst
diff --git a/_sources/usage.rst.txt b/_sources/usage.rst.txt
@@ -0,0 +1,87 @@
+=====
+Usage
+=====
+
+Command Line Interface
+~~~~~~~~~~~~~~~~~~~~~~
+
+The decomnano package comes with a command line interface (CLI) that can be used to run the analysis. The configuration file can be found in the `examples`_ directory. Download the configuration file and run the following command.
+
+.. _examples: https://github.com/Ameyanagi/DecomNano/tree/main/examples
+
+.. code-block:: bash
+
+    decomnano -c sweep_example.toml -o sweep_results.csv
+
+The results will be saved in the `sweep_results.csv` file.
+
+The configuration file is a TOML file. The following parameters can be set in the configuration file.
+
+.. code-block:: toml
+
+    # Example configuration file for DecomNano
+
+    # Single run is done if sweep is false
+    # Sweep is done if sweep is true
+    sweep = true
+
+    # You can specify the output file name. If not specified, the default name is "results.csv"
+    output = "sweep_results.csv"
+
+    [input]
+    # input section is used for input of DecomNano if sweep is false
+    # input section is used for input_default of SweepDecomNano if sweep is true
+    dP=2.77
+    dA=2.88
+    fA=0.8
+    nAA=6.2
+    nPP=9.8
+    nAP=0.5
+    nPA=0.53
+    DA=0
+    DAP=18
+    DP=0
+
+    [input_config]
+    # Input_config section is used for defining the sweep range of each parameter.
+    # It is required if sweep is true.
+    # It will be ignored if sweep is false.# Accepted types are number, list and dictionary.
+    # A dictionary will require start, end and step, and will generate a list of range(start, end, step). end is not included as in range() function in python.
+    nAA=0.1                                 
+    DAP=[16, 17, 18]                        
+    DA={start=0, end=2, step=1}           
+
+The variables in the input dictionary different from the paper due to the naming rules of python. Following table shows the correspondence between the variables in the paper and the input dictionary.
+
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        | Notation in paper                         | Keys       | Descriptions                                                          |
+        +===========================================+============+=======================================================================+
+        |:math:`d_P`                                | dP         | Interatomic spacing of Pt nanoparticles                               |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`d_A`                                | dA         | Interatomic spacing of Au nanoparticles                               |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`\frac{M_A}{M_A + M_P}`              | fA         | Molar fraction of Au                                                  |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`n_{A-A}`                            | nAA        | Total first nearest neighbor coordination number of Au-Au bonds.      |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`n_{P-P}`                            | nPP        | Total first nearest neighbor coordination number of Pt-Pt bonds.      |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`n_{A-P}`                            | nAP        | Total first nearest neighbor coordination number of Au-Pt bonds.      |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`n_{P-A}`                            | nPA        | Total first nearest neighbor coordination number of Pt-Au bonds.      |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`D_A`                                | DA         | Diameter of Au nanoparticles                                          |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`D_{AP}`                             | DAP        | Diameter of PtAu nanoparticles                                        |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+        |:math:`D_P`                                | DP         | Diameter of Pt nanoparticles                                          |
+        +-------------------------------------------+------------+-----------------------------------------------------------------------+
+
+
+Python API
+~~~~~~~~~~
+
+The decomanano package can be imported and used in python scripts.
+Please refer to the `API documentation`_ for details.
+
+.. _API documentation: https://ameyanagi.github.io/DecomNano/modules.html