diff --git a/docs/source/create_miniconda_installer_links_rst.py b/docs/source/create_miniconda_installer_links_rst.py index 3e008285e..4dd3148d8 100755 --- a/docs/source/create_miniconda_installer_links_rst.py +++ b/docs/source/create_miniconda_installer_links_rst.py @@ -22,8 +22,10 @@ from pathlib import Path HERE = Path(__file__).parent -OUT_FILENAME = HERE / "miniconda-other-installer-links.rst" -TEMPLATE_FILENAME = HERE / "miniconda-other-installer-links.rst.jinja2" +OUTFILES = ( + "miniconda.rst", + "miniconda-other-installer-links.rst", +) FILES_URL = "https://repo.anaconda.com/miniconda/.files.json" # Update these! @@ -152,13 +154,13 @@ def get_latest_miniconda_sizes_and_hashes(): def main(): rst_vars = get_latest_miniconda_sizes_and_hashes() - with open(TEMPLATE_FILENAME) as f: - template_text = f.read() + for outfile_name in OUTFILES: + template_file = HERE / f"{outfile_name}.jinja2" + template = Template(template_file.read_text()) - template = Template(template_text) - rst_text = template.render(**rst_vars) - with open(OUT_FILENAME, "w") as f: - f.write(rst_text) + rst_text = template.render(**rst_vars) + outfile = HERE / outfile_name + outfile.write_text(rst_text) if __name__ == "__main__": diff --git a/docs/source/miniconda.rst.jinja2 b/docs/source/miniconda.rst.jinja2 new file mode 100644 index 000000000..2cf89f65f --- /dev/null +++ b/docs/source/miniconda.rst.jinja2 @@ -0,0 +1,98 @@ +========= +Miniconda +========= + +Miniconda is a free minimal installer for conda. It is a small bootstrap version of Anaconda that includes only conda, Python, the packages they +both depend on, and a small number of other useful packages (like pip, zlib, and a few others). If you need more packages, use the ``conda install`` +command to install from thousands of packages available by default in Anaconda’s public repo, or from other channels, like conda-forge or bioconda. + +**Is Miniconda the right conda install for you?** The `Anaconda or Miniconda `_ page lists some reasons why you might want one installation over the other. + +.. toctree:: + :maxdepth: 1 + + miniconda-system-requirements + miniconda-other-installer-links + miniconda-install + miniconda_release_notes + miniconda-other-resources + +.. _miniconda-latest-installer-links: + +Latest Miniconda installer links +================================ + +This list of installers is for the latest release of Python: 3.11.3. For installers for older versions of Python, see :doc:`Other installer links `. For an archive of Miniconda versions, see https://repo.anaconda.com/miniconda/. + +.. csv-table:: Latest - Conda {{ conda_version }} Python {{ python_version }} released {{ release_date }} + :header: Platform,Name,SHA256 hash + :widths: 5, 10, 80 +{% for os in operating_systems %} + {%- for platform in platforms[os,'latest'] %} + {% set first_column = os if loop.first else "" -%} + {{ first_column }},`Miniconda3 {{ platform['description'] }} `_,``{{ platform['hash'] }}`` + {%- endfor -%} +{%- endfor %} + +.. _quick-command-line-install: + +Quick command line install +========================== + +These quick command line instructions will get you set up quickly with the latest Miniconda installer. For graphical installer (`.exe` and `.pkg`) and hash checking instructions, see :doc:`Installing Miniconda `. + +.. tab-set:: + + .. tab-item:: Windows + + These three commands quickly and quietly install the latest 64-bit version of the installer and then clean up after themselves. To install a different version or architecture of Miniconda for Windows, change the name of the ``.exe`` installer in the ``curl`` command. + + .. code-block:: none + + curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe + start /wait "" miniconda.exe /S + del miniconda.exe + + After installing, open the Anaconda Prompt (miniconda3) program to use Miniconda3. The following commands initialize conda for the cmd.exe and Powershell shells: + + .. code-block:: none + + conda init cmd.exe + conda init powershell + + .. tab-item:: macOS + + These four commands quickly and quietly install the latest M1 macOS version of the installer and then clean up after themselves. To install a different version or architecture of Miniconda for macOS, change the name of the ``.sh`` installer in the ``curl`` command. + + .. code-block:: bash + + mkdir -p ~/miniconda3 + curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o ~/miniconda3/miniconda.sh + bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3 + rm -rf ~miniconda3/miniconda.sh + + After installing, initialize your newly-installed Miniconda. The following commands initialize for bash and zsh shells: + + .. code-block:: bash + + ~/miniconda3/bin/conda init bash + ~/miniconda3/bin/conda init zsh + + .. tab-item:: Linux + + These four commands quickly and quietly install the latest 64-bit version of the installer and then clean up after themselves. To install a different version or architecture of Miniconda for Linux, change the name of the ``.sh`` installer in the ``wget`` command. + + .. code-block:: bash + + mkdir -p ~/miniconda3 + wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -o ~/miniconda3/miniconda.sh + bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3 + rm -rf ~/miniconda3/miniconda.sh + + After installing, initialize your newly-installed Miniconda. The following commands initialize for bash and zsh shells: + + .. code-block:: bash + + ~/miniconda3/bin/conda init bash + ~/miniconda3/bin/conda init zsh +