Skip to content

Commit

Permalink
Automated Docs Update
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Apr 22, 2022
1 parent d52371b commit 2a639a1
Show file tree
Hide file tree
Showing 73 changed files with 1,650 additions and 1,446 deletions.
Binary file modified docs/README.doctree
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AIMSim README &mdash; AIMSim 1.0.1 documentation</title>
<title>AIMSim README &mdash; AIMSim 1.0.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down Expand Up @@ -116,14 +116,14 @@ <h2>Purpose<a class="headerlink" href="#purpose" title="Permalink to this headli
<section id="installing-aimsim">
<h2>Installing AIMSim<a class="headerlink" href="#installing-aimsim" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">AIMSim</span></code> can be installed with a single command:
<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">AIMSim</span></code></p>
<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">aimsim</span></code></p>
</section>
<section id="running-aimsim">
<h2>Running AIMSim<a class="headerlink" href="#running-aimsim" title="Permalink to this headline"></a></h2>
<p>Start <code class="docutils literal notranslate"><span class="pre">AIMSim</span></code> with a graphical user interface:</p>
<p><code class="docutils literal notranslate"><span class="pre">AIMSim</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">aimsim</span></code></p>
<p>Start <code class="docutils literal notranslate"><span class="pre">AIMSim</span></code> with a prepared configuration YAML file (<code class="docutils literal notranslate"><span class="pre">config.yaml</span></code>):</p>
<p><code class="docutils literal notranslate"><span class="pre">AIMSim</span> <span class="pre">config.yaml</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">aimsim</span> <span class="pre">config.yaml</span></code></p>
<section id="currently-implemented-fingerprints">
<h3>Currently Implemented Fingerprints<a class="headerlink" href="#currently-implemented-fingerprints" title="Permalink to this headline"></a></h3>
<ol class="arabic simple">
Expand Down
6 changes: 3 additions & 3 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,18 @@ Installing AIMSim
-----------------

``AIMSim`` can be installed with a single command:
``pip install AIMSim``
``pip install aimsim``

Running AIMSim
--------------

Start ``AIMSim`` with a graphical user interface:

``AIMSim``
``aimsim``

Start ``AIMSim`` with a prepared configuration YAML file (\ ``config.yaml``\ ):

``AIMSim config.yaml``
``aimsim config.yaml``

Currently Implemented Fingerprints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
Binary file modified docs/_build/doctrees/README.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/modules.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: a4e6bfb5e07448c9d04f8617733b0af8
config: 6deb4687e754927e5d21283ed34479a1
tags: 645f666f9bcd5a90fca523b33c5a78b7
8 changes: 4 additions & 4 deletions docs/_build/html/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AIMSim README &mdash; AIMSim 1.0.1 documentation</title>
<title>AIMSim README &mdash; AIMSim 1.0.2 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand Down Expand Up @@ -116,14 +116,14 @@ <h2>Purpose<a class="headerlink" href="#purpose" title="Permalink to this headli
<section id="installing-aimsim">
<h2>Installing AIMSim<a class="headerlink" href="#installing-aimsim" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">AIMSim</span></code> can be installed with a single command:
<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">AIMSim</span></code></p>
<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">aimsim</span></code></p>
</section>
<section id="running-aimsim">
<h2>Running AIMSim<a class="headerlink" href="#running-aimsim" title="Permalink to this headline"></a></h2>
<p>Start <code class="docutils literal notranslate"><span class="pre">AIMSim</span></code> with a graphical user interface:</p>
<p><code class="docutils literal notranslate"><span class="pre">AIMSim</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">aimsim</span></code></p>
<p>Start <code class="docutils literal notranslate"><span class="pre">AIMSim</span></code> with a prepared configuration YAML file (<code class="docutils literal notranslate"><span class="pre">config.yaml</span></code>):</p>
<p><code class="docutils literal notranslate"><span class="pre">AIMSim</span> <span class="pre">config.yaml</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">aimsim</span> <span class="pre">config.yaml</span></code></p>
<section id="currently-implemented-fingerprints">
<h3>Currently Implemented Fingerprints<a class="headerlink" href="#currently-implemented-fingerprints" title="Permalink to this headline"></a></h3>
<ol class="arabic simple">
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/_sources/README.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,18 @@ Installing AIMSim
-----------------

``AIMSim`` can be installed with a single command:
``pip install AIMSim``
``pip install aimsim``

Running AIMSim
--------------

Start ``AIMSim`` with a graphical user interface:

``AIMSim``
``aimsim``

Start ``AIMSim`` with a prepared configuration YAML file (\ ``config.yaml``\ ):

``AIMSim config.yaml``
``aimsim config.yaml``

Currently Implemented Fingerprints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
AIMSim.chemical\_datastructures package
aimsim.chemical\_datastructures package
=======================================

Submodules
----------

AIMSim.chemical\_datastructures.molecule module
aimsim.chemical\_datastructures.molecule module
-----------------------------------------------

.. automodule:: AIMSim.chemical_datastructures.molecule
.. automodule:: aimsim.chemical_datastructures.molecule
:members:
:undoc-members:
:show-inheritance:

AIMSim.chemical\_datastructures.molecule\_set module
aimsim.chemical\_datastructures.molecule\_set module
----------------------------------------------------

.. automodule:: AIMSim.chemical_datastructures.molecule_set
.. automodule:: aimsim.chemical_datastructures.molecule_set
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: AIMSim.chemical_datastructures
.. automodule:: aimsim.chemical_datastructures
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
AIMSim.ops package
aimsim.ops package
==================

Submodules
----------

AIMSim.ops.clustering module
aimsim.ops.clustering module
----------------------------

.. automodule:: AIMSim.ops.clustering
.. automodule:: aimsim.ops.clustering
:members:
:undoc-members:
:show-inheritance:

AIMSim.ops.descriptor module
aimsim.ops.descriptor module
----------------------------

.. automodule:: AIMSim.ops.descriptor
.. automodule:: aimsim.ops.descriptor
:members:
:undoc-members:
:show-inheritance:

AIMSim.ops.similarity\_measures module
aimsim.ops.similarity\_measures module
--------------------------------------

.. automodule:: AIMSim.ops.similarity_measures
.. automodule:: aimsim.ops.similarity_measures
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: AIMSim.ops
.. automodule:: aimsim.ops
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
AIMSim package
aimsim package
==============

Subpackages
Expand All @@ -7,26 +7,26 @@ Subpackages
.. toctree::
:maxdepth: 4

AIMSim.chemical_datastructures
AIMSim.ops
AIMSim.tasks
AIMSim.utils
aimsim.chemical_datastructures
aimsim.ops
aimsim.tasks
aimsim.utils

Submodules
----------

AIMSim.exceptions module
aimsim.exceptions module
------------------------

.. automodule:: AIMSim.exceptions
.. automodule:: aimsim.exceptions
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: AIMSim
.. automodule:: aimsim
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,77 +1,77 @@
AIMSim.tasks package
aimsim.tasks package
====================

Submodules
----------

AIMSim.tasks.cluster\_data module
aimsim.tasks.cluster\_data module
---------------------------------

.. automodule:: AIMSim.tasks.cluster_data
.. automodule:: aimsim.tasks.cluster_data
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.compare\_target\_molecule module
aimsim.tasks.compare\_target\_molecule module
---------------------------------------------

.. automodule:: AIMSim.tasks.compare_target_molecule
.. automodule:: aimsim.tasks.compare_target_molecule
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.identify\_outliers module
aimsim.tasks.identify\_outliers module
--------------------------------------

.. automodule:: AIMSim.tasks.identify_outliers
.. automodule:: aimsim.tasks.identify_outliers
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.measure\_search module
aimsim.tasks.measure\_search module
-----------------------------------

.. automodule:: AIMSim.tasks.measure_search
.. automodule:: aimsim.tasks.measure_search
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.see\_property\_variation\_with\_similarity module
aimsim.tasks.see\_property\_variation\_with\_similarity module
--------------------------------------------------------------

.. automodule:: AIMSim.tasks.see_property_variation_with_similarity
.. automodule:: aimsim.tasks.see_property_variation_with_similarity
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.task module
aimsim.tasks.task module
------------------------

.. automodule:: AIMSim.tasks.task
.. automodule:: aimsim.tasks.task
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.task\_manager module
aimsim.tasks.task\_manager module
---------------------------------

.. automodule:: AIMSim.tasks.task_manager
.. automodule:: aimsim.tasks.task_manager
:members:
:undoc-members:
:show-inheritance:

AIMSim.tasks.visualize\_dataset module
aimsim.tasks.visualize\_dataset module
--------------------------------------

.. automodule:: AIMSim.tasks.visualize_dataset
.. automodule:: aimsim.tasks.visualize_dataset
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: AIMSim.tasks
.. automodule:: aimsim.tasks
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
AIMSim.utils package
aimsim.utils package
====================

Submodules
----------

AIMSim.utils.ccbmlib\_fingerprints module
aimsim.utils.ccbmlib\_fingerprints module
-----------------------------------------

.. automodule:: AIMSim.utils.ccbmlib_fingerprints
.. automodule:: aimsim.utils.ccbmlib_fingerprints
:members:
:undoc-members:
:show-inheritance:

AIMSim.utils.plotting\_scripts module
aimsim.utils.plotting\_scripts module
-------------------------------------

.. automodule:: AIMSim.utils.plotting_scripts
.. automodule:: aimsim.utils.plotting_scripts
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: AIMSim.utils
.. automodule:: aimsim.utils
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ AIMSim
.. toctree::
:maxdepth: 4

AIMSim
aimsim
interfaces
setup
tests
Loading

0 comments on commit 2a639a1

Please sign in to comment.