Files
docs
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Technical guide — pyLabFEA 4.3.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=2bf1fcf8" />
<script src="_static/documentation_options.js?v=32fb297c"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Jupyter notebooks" href="examples.html" />
<link rel="prev" title="Python Laboratory for Finite Element Analysis (pyLabFEA)" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="examples.html" title="Jupyter notebooks"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Python Laboratory for Finite Element Analysis (pyLabFEA)"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyLabFEA 4.3.2 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Technical guide</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="technical-guide">
<h1>Technical guide<a class="headerlink" href="#technical-guide" title="Link to this heading">¶</a></h1>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>The pyLabFEA package requires an <a class="reference external" href="https://www.anaconda.com/products/individual">Anaconda</a> or <a class="reference external" href="https://docs.conda.io/en/latest/miniconda.html">Miniconda</a> environment with a recent Python
version. It can be installed directly from its <a class="reference external" href="https://github.com/AHartmaier/pyLabFEA.git">GitHub repository</a> with
the following command</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m pip install git+https://github.com/AHartmaier/pyLabFEA.git
</pre></div>
</div>
<p>Alternatively, the repository can be cloned locally and installed via</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/AHartmaier/pyLabFEA.git
$ cd pyLabFEA.git/trunk/
$ conda env create -f environment.yml
$ conda activate pylabfea$ python -m pip install . --user
</pre></div>
</div>
<p>The correct implementation can be tested with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pytest tests -v
</pre></div>
</div>
<p>After this, the package can by imported into python scripts with</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pylabfea</span> <span class="k">as</span> <span class="nn">FE</span>
</pre></div>
</div>
</section>
<section id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h2>
<p>Online documentations for pyLabFEA is found
under <a class="reference external" href="https://ahartmaier.github.io/pyLabFEA">https://ahartmaier.github.io/pyLabFEA</a>, for offline use
open pyLabFEA/doc/index.html to browse through the contents.
The documentation is generated using <a class="reference external" href="http://www.sphinx-doc.org/en/master/">Sphinx</a>.</p>
</section>
<section id="contributions">
<h2>Contributions<a class="headerlink" href="#contributions" title="Link to this heading">¶</a></h2>
<p>Contributions to the pyLabFEA package are highly welcome, either in form of new
notebooks with application examples or tutorials, or in form of new functionalities
to the Python code. Furthermore, bug reports or any comments on possible improvements of
the code or its documentation are greatly appreciated.</p>
<p>The latest version of the pyLabFEA package can be found on GitHub:
<a class="reference external" href="https://github.com/AHartmaier/pyLabFEA.git">https://github.com/AHartmaier/pyLabFEA.git</a></p>
</section>
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading">¶</a></h2>
<p>pyLabFEA requires the following packages as imports:</p>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference external" href="http://numpy.scipy.org">NumPy</a> for array handling</p></li>
<li><p><a class="reference external" href="https://www.scipy.org/">Scipy</a> for numerical solutions</p></li>
<li><p><a class="reference external" href="https://scikit-learn.org/stable/">scikit-learn</a> for machine learning algorithms</p></li>
<li><p><a class="reference external" href="https://matplotlib.org/">MatPlotLib</a> for graphical output</p></li>
<li><p><a class="reference external" href="https://pandas.pydata.org/">pandas</a> for data import</p></li>
<li><p><a class="reference external" href="https://materialsproject.github.io/fireworks/">fireworks</a> direct import of data resulting from fireworks workflows</p></li>
</ul>
</div></blockquote>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Link to this heading">¶</a></h2>
<p>The pyLabFEA package comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it
under the conditions of the GNU General Public License (<a class="reference external" href="http://www.fsf.org/licensing/licenses/gpl.html">GPLv3</a>)</p>
<p>The contents of the examples and notebooks are published under the
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License
(<a class="reference external" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>)</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Technical guide</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
<li><a class="reference internal" href="#contributions">Contributions</a></li>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Python Laboratory for Finite Element Analysis (pyLabFEA)</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="examples.html"
title="next chapter">Jupyter notebooks</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="examples.html" title="Jupyter notebooks"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Python Laboratory for Finite Element Analysis (pyLabFEA)"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyLabFEA 4.3.2 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Technical guide</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2020 2022, 2024, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
</div>
</body>
</html>