DOC: update development documentation 691779f

ansys · Oct 2, 2023 · 2459cfb · 2459cfb
commit 2459cfb
Show file tree

Hide file tree

Showing 340 changed files with 45,038 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+installer.docs.pyansys.com
diff --git a/index.html b/index.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<meta charset="utf-8">
+<title>Redirecting to https://installer.docs.pyansys.com/version/stable/</title>
+<meta name="description" content="">
+<meta http-equiv="refresh" content="0; URL=https://installer.docs.pyansys.com/version/stable/">
+<link rel="canonical" href="https://installer.docs.pyansys.com/version/stable/">
diff --git a/sitemap.xml b/sitemap.xml
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>https://www.installer.docs.pyansys.com</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>daily</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/genindex</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/search</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/_static/webpack-macros</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/index</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/user_guide</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/installer</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+  <url>
+    <loc>https://www.installer.docs.pyansys.com/contributing</loc>
+    <lastmod>2023-09-26T07:32:28+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.5</priority>
+  </url>
+</urlset>
diff --git a/version/0.1/.buildinfo b/version/0.1/.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: 948263efd1ee215a90a15d06e401a667
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/version/0.1/_images/app-image.png b/version/0.1/_images/app-image.png
diff --git a/version/0.1/_sources/contributing.rst.txt b/version/0.1/_sources/contributing.rst.txt
@@ -0,0 +1,19 @@
+.. _ref_contributing:
+
+Contributing
+============
+
+We absolutely welcome any code contributions and we hope that this
+guide will facilitate an understanding of the ``ansys-tools-installer`` code
+repository. It is important to note that while the ``ansys-tools-installer`` software
+package is maintained by ANSYS and any submissions will be reviewed
+thoroughly before merging, we still seek to foster a community that can
+support user questions and develop new features to make this software
+a useful tool for all users. As such, we welcome and encourage any
+questions or submissions to this repository.
+
+For contributing to this project, please refer to the
+`PyAnsys Developer's Guide`_.
+
+.. include:: ../../README.rst
+   :start-after: .. contribute_start
diff --git a/version/0.1/_sources/index.rst.txt b/version/0.1/_sources/index.rst.txt
@@ -0,0 +1,13 @@
+..
+   Just reuse the root readme to avoid duplicating the documentation.
+   Provide any documentation specific to your online documentation
+   here.
+
+.. include:: ../../README.rst
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   installer
+   contributing
diff --git a/version/0.1/_sources/installer.rst.txt b/version/0.1/_sources/installer.rst.txt
@@ -0,0 +1,89 @@
+Usage instructions
+##################
+
+Installing the ``Ansys Python Manager``
+=======================================
+
+First step is installing the ``Ansys Python Manager``. In order to do so, follow the next steps.
+
+#. Download the necessary installer from the `latest available release <https://github.com/pyansys/python-installer-qt-gui/releases/latest>`_.
+   The file should be named ``Ansys-Python-Manager-Setup-v*.exe``.
+
+#. Execute the installer.
+
+#. Search for the ``Ansys Python Manager`` and run it.
+
+The ``Ansys Python Manager`` window should appear at this stage.
+
+Installing Python on Windows
+============================
+
+Now, instructions on how to install Python from the ``Ansys Python Manager`` are provided.
+
+In order to do so, just follow the upcoming steps:
+
+#. Search for the ``Ansys Python Manager`` and run it.
+
+#. Go to the ``Install Python`` tab, and select your desired Python install, version and extra packages.
+
+#. And follow the install process.
+
+
+Configurable options for the installer
+--------------------------------------
+
+Two Python options for installation are available:
+
+* ``Standard``: this mode installs the standard Python version from `python.org <https://www.python.org/>`_
+* ``Conda (miniforge)``: this mode installs the Python version from `miniforge <https://github.com/conda-forge/miniforge>`_.
+  This install is characterized for being a modified ``conda`` install in which you have access to the ``conda``
+  package manager through the ``conda-forge`` channel.
+
+Regarding the available Python versions, users can select among the following ones:
+
+* Python 3.7
+* Python 3.8
+* Python 3.9
+* Python 3.10
+* Python 3.11
+
+.. warning::
+
+  In the case of having selected ``Conda (miniforge)``, only Python 3.10 is available.
+
+
+Managing Python environments
+============================
+
+Through the ``Ansys Python Manager``, users can also have access to their different Python
+installations. Have a look at how to access it here:
+
+#. Search for the ``Ansys Python Manager`` and run it.
+
+#. Access the ``Manage Python Environments`` tab.
+
+#. Select your desired ``Python`` environment and start one of the listed options.
+
+
+On the ``Launching options`` section, the following options are available:
+
+* ``Launch Console``: this option starts a console window with the command ``python`` pointing
+  towards your selected Python environment.
+* ``Launch JupyterLab``: this option starts a ``JupyterLab`` session. If ``JupyterLab`` is
+  not installed, then the ``Ansys Python Manager`` installs it for you.
+* ``Launch Jupyter Notebook``: this option starts a ``Jupyter Notebook`` session. If
+  ``Jupyter Notebook`` is not installed, then the ``Ansys Python Manager`` installs it for you.
+* ``Launch Spyder``: this option starts a Spyder IDE session. If Spyder is not installed,
+  then the ``Ansys Python Manager`` installs it for you.
+
+On the ``Package management`` section, the following options are available:
+
+* ``Install Python default packages``: by selecting this option, your selected Python install
+  receives the latest compatible versions for ``numpy``, ``scipy``, ``pandas``, ``matplotlib``
+  and  ``scikit-learn``.
+* ``Install PyAnsys``: by selecting this option, your selected Python install has access to
+  the latest, compatible PyAnsys metapackage installation. This metapackage provides you with
+  access to the latest public PyAnsys libraries in their compatible version with the latest
+  Ansys products.
+* ``List installed packages``: by selecting this option, a list of the installed packages on
+  your selected Python install is provided. This might be useful for identifying potential problems.
diff --git a/version/0.1/_static/404.rst b/version/0.1/_static/404.rst
@@ -0,0 +1,6 @@
+Oops!
+=====
+
+This is unexpected. The page you are requesting does not exist.
+
+If this page should exist, please contact `{{ theme_contact_mail }} <{{ theme_contact_mail }}>`_.
diff --git a/version/0.1/_static/README.md b/version/0.1/_static/README.md
@@ -0,0 +1 @@
+Static files are found here (like images and other assets).
diff --git a/version/0.1/_static/_sphinx_javascript_frameworks_compat.js b/version/0.1/_static/_sphinx_javascript_frameworks_compat.js
@@ -0,0 +1,134 @@
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}
diff --git a/version/0.1/_static/ansys-favicon.png b/version/0.1/_static/ansys-favicon.png
diff --git a/version/0.1/_static/ansys_logo_black.jpg b/version/0.1/_static/ansys_logo_black.jpg
diff --git a/version/0.1/_static/ansys_logo_black_cropped.jpg b/version/0.1/_static/ansys_logo_black_cropped.jpg
diff --git a/version/0.1/_static/ansys_logo_white.pdf b/version/0.1/_static/ansys_logo_white.pdf
diff --git a/version/0.1/_static/ansys_logo_white_cropped.pdf b/version/0.1/_static/ansys_logo_white_cropped.pdf
diff --git a/version/0.1/_static/app-image.png b/version/0.1/_static/app-image.png