Automated documentation rebuild

ReactionMechanismGenerator · Oct 8, 2024 · cc4aeb4 · cc4aeb4
1 parent fbedd10
commit cc4aeb4
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 85 deletions.
diff --git a/_sources/users/rmg/installation/anacondaDeveloper.rst.txt b/_sources/users/rmg/installation/anacondaDeveloper.rst.txt
@@ -4,26 +4,7 @@
 Installation by Source Using Anaconda Environment for Unix-based Systems: Linux and Mac OSX
 *******************************************************************************************
 
-#. Install the `conda` package manager, if you do not already have it (or Anaconda).
-   Select one of the following options:
-
-   a. Users of Fedora Linux and Red Hat derivatives (RHEL, CentOS Stream) may install from the official repositories and EPEL, respectively, with the command ::
-
-       sudo dnf install conda
-
-   b. All other users, download and install `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_.
-
-      The download will be a .sh file with a name like ``Miniconda3-latest-Linux-x86_64.sh``.
-      Open a terminal in the same directory as this file, and type the following to install Conda
-      (replace the name of your .sh file below). ::
-
-       bash Miniconda3-latest-Linux-x86_64.sh
-
-      **When prompted to append Anaconda to your PATH, select or type Yes**. 
-      Install the Conda folder inside your home directory 
-      (typically ``/home/YourUsername/`` in Linux and ``/Users/YourUsername`` in Mac).
-
-      Note that you should reinitialize or restart your terminal in order for the changes to take effect, as the installer will tell you.
+#. Install the `conda` package manager via `miniforge`, if you do not already have it (or Anaconda), by following the `Miniforge installation instructions <https://github.com/conda-forge/miniforge?tab=readme-ov-file#install>`_.
 
 #. There are a few system-level dependencies which are required and should not be installed via Conda. These include
    `Git <https://git-scm.com/>`_ for version control, `GNU Make <https://www.gnu.org/software/make/>`_, and the C and C++ compilers from the `GNU Compiler Collection (GCC) <https://gcc.gnu.org/>`_ for compiling RMG.

diff --git a/_sources/users/rmg/installation/anacondaUser.rst.txt b/_sources/users/rmg/installation/anacondaUser.rst.txt
@@ -5,26 +5,7 @@ Binary Installation Using Anaconda for Unix-Based Systems: Linux and Mac OSX
 ****************************************************************************
 
 
-#. Install the `conda` package manager, if you do not already have it (or Anaconda).
-   Select one of the following options:
-
-   a. Users of Fedora Linux and Red Hat derivatives (RHEL, CentOS Stream) may install from the official repositories and EPEL, respectively, with the command ::
-
-       sudo dnf install conda
-
-   b. All other users, download and install `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_.
-
-      The download will be a .sh file with a name like ``Miniconda3-latest-Linux-x86_64.sh``.
-      Open a terminal in the same directory as this file, and type the following to install Conda
-      (replace the name of your .sh file below). ::
-
-       bash Miniconda3-latest-Linux-x86_64.sh
-
-      **When prompted to append Anaconda to your PATH, select or type Yes**. 
-      Install the Conda folder inside your home directory 
-      (typically ``/home/YourUsername/`` in Linux and ``/Users/YourUsername`` in Mac).
-
-      Note that you should reinitialize or restart your terminal in order for the changes to take effect, as the installer will tell you.
+#. Install the `conda` package manager via `miniforge`, if you do not already have it (or Anaconda), by following the `Miniforge installation instructions <https://github.com/conda-forge/miniforge?tab=readme-ov-file#install>`_.
 
 #. Install both RMG and the RMG-database binaries through the terminal.   Dependencies will be installed automatically. It is safest to make a new conda environment for RMG and its dependencies. Type the following command into the terminal to create the new environment named 'rmg_env' containing the latest stable version of the RMG program and its database. ::
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/users/rmg/installation/anacondaDeveloper.html b/users/rmg/installation/anacondaDeveloper.html
@@ -63,28 +63,7 @@ <h3>Navigation</h3>
   <section id="installation-by-source-using-anaconda-environment-for-unix-based-systems-linux-and-mac-osx">
 <span id="anacondadeveloper"></span><h1><span class="section-number">3.3.1. </span>Installation by Source Using Anaconda Environment for Unix-based Systems: Linux and Mac OSX<a class="headerlink" href="#installation-by-source-using-anaconda-environment-for-unix-based-systems-linux-and-mac-osx" title="Permalink to this heading">¶</a></h1>
 <ol class="arabic">
-<li><p>Install the <cite>conda</cite> package manager, if you do not already have it (or Anaconda).
-Select one of the following options:</p>
-<ol class="loweralpha">
-<li><p>Users of Fedora Linux and Red Hat derivatives (RHEL, CentOS Stream) may install from the official repositories and EPEL, respectively, with the command</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">dnf</span> <span class="n">install</span> <span class="n">conda</span>
-</pre></div>
-</div>
-</li>
-<li><p>All other users, download and install <a class="reference external" href="https://docs.conda.io/en/latest/miniconda.html">Miniconda</a>.</p>
-<p>The download will be a .sh file with a name like <code class="docutils literal notranslate"><span class="pre">Miniconda3-latest-Linux-x86_64.sh</span></code>.
-Open a terminal in the same directory as this file, and type the following to install Conda
-(replace the name of your .sh file below).</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bash</span> <span class="n">Miniconda3</span><span class="o">-</span><span class="n">latest</span><span class="o">-</span><span class="n">Linux</span><span class="o">-</span><span class="n">x86_64</span><span class="o">.</span><span class="n">sh</span>
-</pre></div>
-</div>
-<p><strong>When prompted to append Anaconda to your PATH, select or type Yes</strong>.
-Install the Conda folder inside your home directory
-(typically <code class="docutils literal notranslate"><span class="pre">/home/YourUsername/</span></code> in Linux and <code class="docutils literal notranslate"><span class="pre">/Users/YourUsername</span></code> in Mac).</p>
-<p>Note that you should reinitialize or restart your terminal in order for the changes to take effect, as the installer will tell you.</p>
-</li>
-</ol>
-</li>
+<li><p>Install the <cite>conda</cite> package manager via <cite>miniforge</cite>, if you do not already have it (or Anaconda), by following the <a class="reference external" href="https://github.com/conda-forge/miniforge?tab=readme-ov-file#install">Miniforge installation instructions</a>.</p></li>
 <li><p>There are a few system-level dependencies which are required and should not be installed via Conda. These include
 <a class="reference external" href="https://git-scm.com/">Git</a> for version control, <a class="reference external" href="https://www.gnu.org/software/make/">GNU Make</a>, and the C and C++ compilers from the <a class="reference external" href="https://gcc.gnu.org/">GNU Compiler Collection (GCC)</a> for compiling RMG.</p>
 <p>For Linux users, you can check whether these are already installed by simply calling them via the command line, which

diff --git a/users/rmg/installation/anacondaUser.html b/users/rmg/installation/anacondaUser.html
@@ -63,28 +63,7 @@ <h3>Navigation</h3>
   <section id="binary-installation-using-anaconda-for-unix-based-systems-linux-and-mac-osx">
 <span id="anacondauser"></span><h1><span class="section-number">3.2.1. </span>Binary Installation Using Anaconda for Unix-Based Systems: Linux and Mac OSX<a class="headerlink" href="#binary-installation-using-anaconda-for-unix-based-systems-linux-and-mac-osx" title="Permalink to this heading">¶</a></h1>
 <ol class="arabic">
-<li><p>Install the <cite>conda</cite> package manager, if you do not already have it (or Anaconda).
-Select one of the following options:</p>
-<ol class="loweralpha">
-<li><p>Users of Fedora Linux and Red Hat derivatives (RHEL, CentOS Stream) may install from the official repositories and EPEL, respectively, with the command</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">dnf</span> <span class="n">install</span> <span class="n">conda</span>
-</pre></div>
-</div>
-</li>
-<li><p>All other users, download and install <a class="reference external" href="https://docs.conda.io/en/latest/miniconda.html">Miniconda</a>.</p>
-<p>The download will be a .sh file with a name like <code class="docutils literal notranslate"><span class="pre">Miniconda3-latest-Linux-x86_64.sh</span></code>.
-Open a terminal in the same directory as this file, and type the following to install Conda
-(replace the name of your .sh file below).</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bash</span> <span class="n">Miniconda3</span><span class="o">-</span><span class="n">latest</span><span class="o">-</span><span class="n">Linux</span><span class="o">-</span><span class="n">x86_64</span><span class="o">.</span><span class="n">sh</span>
-</pre></div>
-</div>
-<p><strong>When prompted to append Anaconda to your PATH, select or type Yes</strong>.
-Install the Conda folder inside your home directory
-(typically <code class="docutils literal notranslate"><span class="pre">/home/YourUsername/</span></code> in Linux and <code class="docutils literal notranslate"><span class="pre">/Users/YourUsername</span></code> in Mac).</p>
-<p>Note that you should reinitialize or restart your terminal in order for the changes to take effect, as the installer will tell you.</p>
-</li>
-</ol>
-</li>
+<li><p>Install the <cite>conda</cite> package manager via <cite>miniforge</cite>, if you do not already have it (or Anaconda), by following the <a class="reference external" href="https://github.com/conda-forge/miniforge?tab=readme-ov-file#install">Miniforge installation instructions</a>.</p></li>
 <li><p>Install both RMG and the RMG-database binaries through the terminal.   Dependencies will be installed automatically. It is safest to make a new conda environment for RMG and its dependencies. Type the following command into the terminal to create the new environment named ‘rmg_env’ containing the latest stable version of the RMG program and its database.</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">c</span> <span class="n">defaults</span> <span class="o">-</span><span class="n">c</span> <span class="n">rmg</span> <span class="o">-</span><span class="n">c</span> <span class="n">rdkit</span> <span class="o">-</span><span class="n">c</span> <span class="n">cantera</span> <span class="o">-</span><span class="n">c</span> <span class="n">pytorch</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="o">--</span><span class="n">name</span> <span class="n">rmg_env</span> <span class="n">rmg</span> <span class="n">rmgdatabase</span>
 </pre></div>