Added installation to docs

senthurayyappan · Aug 29, 2020 · 55a77ae · 55a77ae
1 parent 822f66e
commit 55a77ae
Show file tree

Hide file tree

Showing 25 changed files with 114 additions and 139 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/introduction.doctree b/docs/_build/doctrees/introduction.doctree
diff --git a/docs/_build/doctrees/license.doctree b/docs/_build/doctrees/license.doctree
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -22,16 +22,28 @@ Welcome to anton's documentation!
    :target: https://gitter.im/blender-for-science/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
    :alt: Gitter
 
-anton is a generative design framework built on Blender, the open-source 3D creation suite.
-
 .. image:: ../anton.gif
    :alt: anton
 
+
+What is Generative design?
+--------------------------
+
+Generative design is an iterative design exploration process that yields feasible design outcomes based on a set of well-defined 
+constraints and performance objectives, using one or more optimization methodologies. In practice, Topology optimization is used to generate
+numerous design outcomes by varying its parameters within an interval and the generated outcomes that best meet the performance objectives are filtered and processed further.
+
+What is anton?
+--------------
+
+anton is an open-source generative design framework built on Blender, the open-source 3D creation suite. 
+At its current stage of development, anton uses a density-based topology optimization methodology as a design generator and
+uses implicit surfaces for mesh generation.
+
 .. toctree::
    :hidden:
    :maxdepth: 2
 
-   introduction
    installation
    quickstart
    scripts

diff --git a/docs/_build/html/_sources/installation.rst.txt b/docs/_build/html/_sources/installation.rst.txt
@@ -1,2 +1,15 @@
 Installation
 ============
+
+* Download the latest release
+* Open Blender and head over to ``Edit`` -> ``Preferences`` -> ``Add-ons`` -> ``Install``
+* Navigate to the downloaded **.zip** file and click ``Install Add-on``
+* Enable the installed add-on, anton looks for the these python modules,
+    * ``Numpy``
+    * ``Scipy``
+    * ``Scikit-learn``    
+    * ``gmsh-api``
+    * ``tqdm``
+
+* If you dont have these modules installed, click on ``Install required modules``
+
diff --git a/docs/_build/html/_sources/introduction.rst.txt b/docs/_build/html/_sources/introduction.rst.txt
diff --git a/docs/_build/html/_sources/license.rst.txt b/docs/_build/html/_sources/license.rst.txt
@@ -7,3 +7,12 @@ The GNU General Public License is a free, `copyleft <https://en.wikipedia.org/wi
 The licenses for most software and other practical works are designed to take away your freedom to share 
 and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to 
 share and change all versions of a program--to make sure it remains free software for all its users.
+
+anton includes functions from pyOptFEM, a Python module providing simple and efficient vectorized routines for assembling 
+P1-Lagrange Finite Element matrices in 2D and 3D. pyOptFEM is free software: you can redistribute it and/or modify it under the terms 
+of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+**ATTRIBUTION NOTICE**: This product includes software developed for the pyOptFEM project at (C) University Paris XIII, Galilee Institute, LAGA, France. 
+pyOptFEM is a python software package for P_1-Lagrange Finite Element Methods in 3D. The project is maintained by F. Cuvelier, C. Japhet and G. Scarella. 
+For Online Documentation and Download we refer to http://www.math.univ-paris13.fr/~cuvelier
+
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -208,7 +208,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -16,7 +16,7 @@
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Introduction" href="introduction.html" />
+    <link rel="next" title="Installation" href="installation.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -39,10 +39,21 @@ <h1>Welcome to anton’s documentation!<a class="headerlink" href="#welcome-to-a
 <a class="reference external image-reference" href="https://www.codacy.com?utm_source=github.com&amp;amp;utm_medium=referral&amp;amp;utm_content=blender-for-science/anton&amp;amp;utm_campaign=Badge_Grade"><img alt="Codacy" src="https://app.codacy.com/project/badge/Grade/e0da62cdb7bc499b95bf70c18e8013cd" /></a>
 <a class="reference external image-reference" href="https://github.com/blender-for-science/anton/blob/master/LICENSE.md"><img alt="License" src="https://img.shields.io/github/license/blender-for-science/blendmsh" /></a>
 <a class="reference external image-reference" href="https://gitter.im/blender-for-science/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img alt="Gitter" src="https://badges.gitter.im/blender-for-science/community.svg" /></a>
-<p>anton is a generative design framework built on Blender, the open-source 3D creation suite.</p>
 <img alt="anton" src="_images/anton.gif" />
+<div class="section" id="what-is-generative-design">
+<h2>What is Generative design?<a class="headerlink" href="#what-is-generative-design" title="Permalink to this headline">¶</a></h2>
+<p>Generative design is an iterative design exploration process that yields feasible design outcomes based on a set of well-defined
+constraints and performance objectives, using one or more optimization methodologies. In practice, Topology optimization is used to generate
+numerous design outcomes by varying its parameters within an interval and the generated outcomes that best meet the performance objectives are filtered and processed further.</p>
+</div>
+<div class="section" id="what-is-anton">
+<h2>What is anton?<a class="headerlink" href="#what-is-anton" title="Permalink to this headline">¶</a></h2>
+<p>anton is an open-source generative design framework built on Blender, the open-source 3D creation suite.
+At its current stage of development, anton uses a density-based topology optimization methodology as a design generator and
+uses implicit surfaces for mesh generation.</p>
 <div class="toctree-wrapper compound">
 </div>
+</div>
 </div>
 
 
@@ -63,7 +74,6 @@ <h1 class="logo"><a href="#">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>
@@ -75,7 +85,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="#">Documentation overview</a><ul>
-      <li>Next: <a href="introduction.html" title="next chapter">Introduction</a></li>
+      <li>Next: <a href="installation.html" title="next chapter">Installation</a></li>
   </ul></li>
 </ul>
 </div>

diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html
@@ -17,7 +17,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Quickstart" href="quickstart.html" />
-    <link rel="prev" title="Introduction" href="introduction.html" />
+    <link rel="prev" title="Welcome to anton’s documentation!" href="index.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -36,6 +36,23 @@
 
   <div class="section" id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
+<li><p>Download the latest release</p></li>
+<li><p>Open Blender and head over to <code class="docutils literal notranslate"><span class="pre">Edit</span></code> -&gt; <code class="docutils literal notranslate"><span class="pre">Preferences</span></code> -&gt; <code class="docutils literal notranslate"><span class="pre">Add-ons</span></code> -&gt; <code class="docutils literal notranslate"><span class="pre">Install</span></code></p></li>
+<li><p>Navigate to the downloaded <strong>.zip</strong> file and click <code class="docutils literal notranslate"><span class="pre">Install</span> <span class="pre">Add-on</span></code></p></li>
+<li><dl class="simple">
+<dt>Enable the installed add-on, anton looks for the these python modules,</dt><dd><ul>
+<li><p><code class="docutils literal notranslate"><span class="pre">Numpy</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Scipy</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">Scikit-learn</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">gmsh-api</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">tqdm</span></code></p></li>
+</ul>
+</dd>
+</dl>
+</li>
+<li><p>If you dont have these modules installed, click on <code class="docutils literal notranslate"><span class="pre">Install</span> <span class="pre">required</span> <span class="pre">modules</span></code></p></li>
+</ul>
 </div>
 
 
@@ -56,7 +73,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>
@@ -68,7 +84,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="introduction.html" title="previous chapter">Introduction</a></li>
+      <li>Previous: <a href="index.html" title="previous chapter">Welcome to anton’s documentation!</a></li>
       <li>Next: <a href="quickstart.html" title="next chapter">Quickstart</a></li>
   </ul></li>
 </ul>

diff --git a/docs/_build/html/introduction.html b/docs/_build/html/introduction.html
diff --git a/docs/_build/html/license.html b/docs/_build/html/license.html
@@ -40,6 +40,12 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headli
 The licenses for most software and other practical works are designed to take away your freedom to share
 and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to
 share and change all versions of a program–to make sure it remains free software for all its users.</p>
+<p>anton includes functions from pyOptFEM, a Python module providing simple and efficient vectorized routines for assembling
+P1-Lagrange Finite Element matrices in 2D and 3D. pyOptFEM is free software: you can redistribute it and/or modify it under the terms
+of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
+<p><strong>ATTRIBUTION NOTICE</strong>: This product includes software developed for the pyOptFEM project at (C) University Paris XIII, Galilee Institute, LAGA, France.
+pyOptFEM is a python software package for P_1-Lagrange Finite Element Methods in 3D. The project is maintained by F. Cuvelier, C. Japhet and G. Scarella.
+For Online Documentation and Download we refer to <a class="reference external" href="http://www.math.univ-paris13.fr/~cuvelier">http://www.math.univ-paris13.fr/~cuvelier</a></p>
 </div>
 
 
@@ -60,7 +66,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -107,7 +107,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>

diff --git a/docs/_build/html/quickstart.html b/docs/_build/html/quickstart.html
@@ -56,7 +56,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>

diff --git a/docs/_build/html/release.html b/docs/_build/html/release.html
@@ -56,7 +56,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>

diff --git a/docs/_build/html/scripts.html b/docs/_build/html/scripts.html
@@ -337,7 +337,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Scripts</a><ul>

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -76,7 +76,6 @@ <h1 class="logo"><a href="index.html">anton</a></h1>
 
 <h3>Navigation</h3>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</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="quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="scripts.html">Scripts</a></li>