Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Su Tian authored and Su Tian committed Aug 19, 2020
1 parent 7bf3404 commit 1828868
Show file tree
Hide file tree
Showing 36 changed files with 1,663 additions and 219 deletions.
45 changes: 23 additions & 22 deletions analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,22 @@


def solve(sg_xml, analysis, solver, scrnout=True):
"""
"""Solve
Parameters
----------
sg_xml : str
File name of SG design parameters (XML format)
File name of SG design parameters (XML format).
analysis : str
Analysis to be carried out
h - homogenization
d - dehomogenization/localization/recover
f - initial failure strength
fe - initial failure envelope
fi - initial failure indices and strength ratios
Analysis to be carried out.
* h - homogenization
* d - dehomogenization/localization/recover
* f - initial failure strength
* fe - initial failure envelope
* fi - initial failure indices and strength ratios
solver : str
Format of the generated input file ('vabs' or 'swiftcomp')
Format of the generated input file ('vabs' or 'swiftcomp').
"""

# Preprocess
Expand All @@ -49,26 +50,26 @@ def solve(sg_xml, analysis, solver, scrnout=True):


def run(input_name, analysis, solver, smdim, scrnout=True):
""" Run codes
"""Run codes.
Parameters
----------
solver : str
Excect command string of the code ('vabs' or 'swiftcomp')
Excect command string of the code ('vabs' or 'swiftcomp').
input_name : str
Name of the input file
Name of the input file.
analysis : str
Analysis to be carried out
h - homogenization
d or l - dehomogenization/localization/recover
f - initial failure strength
fe - initial failure envelope
fi - initial failure indices and strength ratios
smdim : int
Dimension of the macroscopic structural model
Analysis to be carried out.
:param scrnout: Print solver messages
:type scrnout: bool
* h - homogenization
* d or l - dehomogenization/localization/recover
* f - initial failure strength
* fe - initial failure envelope
* fi - initial failure indices and strength ratios
smdim : int
Dimension of the macroscopic structural model.
scrnout : bool
Print solver messages.
"""
try:
analysis_long = {
Expand Down
Binary file modified analysis.pyc
Binary file not shown.
Binary file added doc/build/doctrees/analysis.doctree
Binary file not shown.
Binary file modified doc/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified doc/build/doctrees/index.doctree
Binary file not shown.
Binary file modified doc/build/doctrees/ioutils.doctree
Binary file not shown.
Binary file modified doc/build/doctrees/iovabs.doctree
Binary file not shown.
Binary file added doc/build/doctrees/presg.doctree
Binary file not shown.
Binary file modified doc/build/doctrees/sg.doctree
Binary file not shown.
13 changes: 13 additions & 0 deletions doc/build/html/_sources/analysis.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
analysis Module
===============

.. highlight:: python

::

import msgpi.analysis

.. autofunction:: msgpi.analysis.solve

.. autofunction:: msgpi.analysis.run

2 changes: 2 additions & 0 deletions doc/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Welcome to Some scripts's documentation!
sg
iovabs
ioutils
presg
analysis

Indices and tables
==================
Expand Down
15 changes: 15 additions & 0 deletions doc/build/html/_sources/presg.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
presg Module
============

.. highlight:: python

::

import msgpi.presg

.. autofunction:: msgpi.presg.readMaterialFromXMLElement

.. autofunction:: msgpi.presg.preSG1D

.. autofunction:: msgpi.presg.preSG

263 changes: 263 additions & 0 deletions doc/build/html/analysis.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>analysis Module &mdash; msgpi documentation</title>








<script type="text/javascript" src="_static/js/modernizr.min.js"></script>


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>




<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="presg Module" href="presg.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"> msgpi



</a>







<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="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="main navigation">






<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="sg.html">Class Module for MSM Structure Gene</a></li>
<li class="toctree-l1"><a class="reference internal" href="iovabs.html">SG I/O Module for VABS</a></li>
<li class="toctree-l1"><a class="reference internal" href="ioutils.html">I/O Utility Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="presg.html">presg Module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">analysis Module</a></li>
</ul>



</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">msgpi</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

















<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="index.html">Docs</a> &raquo;</li>

<li>analysis Module</li>


<li class="wy-breadcrumbs-aside">


<a href="_sources/analysis.rst.txt" rel="nofollow"> View page source</a>


</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="section" id="analysis-module">
<h1>analysis Module<a class="headerlink" href="#analysis-module" title="Permalink to this headline"></a></h1>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">msgpi.analysis</span>
</pre></div>
</div>
<dl class="function">
<dt id="msgpi.analysis.solve">
<code class="descclassname">msgpi.analysis.</code><code class="descname">solve</code><span class="sig-paren">(</span><em>sg_xml</em>, <em>analysis</em>, <em>solver</em>, <em>scrnout=True</em><span class="sig-paren">)</span><a class="headerlink" href="#msgpi.analysis.solve" title="Permalink to this definition"></a></dt>
<dd><p>Solve</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>sg_xml</strong> (<em>str</em>) – File name of SG design parameters (XML format).</li>
<li><strong>analysis</strong> (<em>str</em>) – <p>Analysis to be carried out.</p>
<ul>
<li>h - homogenization</li>
<li>d - dehomogenization/localization/recover</li>
<li>f - initial failure strength</li>
<li>fe - initial failure envelope</li>
<li>fi - initial failure indices and strength ratios</li>
</ul>
</li>
<li><strong>solver</strong> (<em>str</em>) – Format of the generated input file (‘vabs’ or ‘swiftcomp’).</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="msgpi.analysis.run">
<code class="descclassname">msgpi.analysis.</code><code class="descname">run</code><span class="sig-paren">(</span><em>input_name</em>, <em>analysis</em>, <em>solver</em>, <em>smdim</em>, <em>scrnout=True</em><span class="sig-paren">)</span><a class="headerlink" href="#msgpi.analysis.run" title="Permalink to this definition"></a></dt>
<dd><p>Run codes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>solver</strong> (<em>str</em>) – Excect command string of the code (‘vabs’ or ‘swiftcomp’).</li>
<li><strong>input_name</strong> (<em>str</em>) – Name of the input file.</li>
<li><strong>analysis</strong> (<em>str</em>) – <p>Analysis to be carried out.</p>
<ul>
<li>h - homogenization</li>
<li>d or l - dehomogenization/localization/recover</li>
<li>f - initial failure strength</li>
<li>fe - initial failure envelope</li>
<li>fi - initial failure indices and strength ratios</li>
</ul>
</li>
<li><strong>smdim</strong> (<em>int</em>) – Dimension of the macroscopic structural model.</li>
<li><strong>scrnout</strong> (<em>bool</em>) – Print solver messages.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


</div>

</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">


<a href="presg.html" class="btn btn-neutral float-left" title="presg Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>


<hr/>

<div role="contentinfo">
<p>
&copy; Copyright 2020, msm group

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

</section>

</div>



<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>






</body>
</html>
Loading

0 comments on commit 1828868

Please sign in to comment.