diff --git a/docs/source/conf.py b/docs/source/conf.py index 5463225ff..240c1e847 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,6 +39,7 @@ "sphinx.ext.inheritance_diagram", # 'sphinx.ext.napoleon', "sphinx_sitemap", + "sphinx_design", ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/create_miniconda_hash_rst.py b/docs/source/create_miniconda_hash_rst.py index b65144535..ee113eaff 100644 --- a/docs/source/create_miniconda_hash_rst.py +++ b/docs/source/create_miniconda_hash_rst.py @@ -21,7 +21,7 @@ HASH_LEN = 68 HERE = Path(__file__).parent -OUT_FILENAME = HERE / "miniconda_hashes.rst" +OUT_FILENAME = HERE / "miniconda-hashes.rst" def sizeof_fmt(num, suffix="B"): diff --git a/docs/source/create_miniconda_rst.py b/docs/source/create_miniconda_installer_links_rst.py similarity index 93% rename from docs/source/create_miniconda_rst.py rename to docs/source/create_miniconda_installer_links_rst.py index 8418d7594..885fb30a4 100755 --- a/docs/source/create_miniconda_rst.py +++ b/docs/source/create_miniconda_installer_links_rst.py @@ -22,8 +22,10 @@ from packaging.version import Version HERE = Path(__file__).parent -OUT_FILENAME = HERE / "miniconda.rst" -TEMPLATE_FILENAME = HERE / "miniconda.rst.jinja2" +OUTFILES = ( + "miniconda.rst", + "miniconda-other-installer-links.rst", +) FILES_URL = "https://repo.anaconda.com/miniconda/.files.json" # Update these! @@ -154,13 +156,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-install.rst b/docs/source/miniconda-install.rst new file mode 100644 index 000000000..294cb557f --- /dev/null +++ b/docs/source/miniconda-install.rst @@ -0,0 +1,87 @@ +==================== +Installing Miniconda +==================== + +.. _cryptographic-hash-verification: https://conda.io/projects/conda/en/stable/user-guide/install/download.html#cryptographic-hash-verification +.. _conda-windows-install: https://conda.io/projects/conda/en/stable/user-guide/install/windows.html +.. _conda-macOS-install: https://conda.io/projects/conda/en/stable/user-guide/install/macos.html + +This page contains more complex installation instructions for the major operating systems. For a command-line quickstart installation, see :ref:`Quick Command Line Install `. + +.. note:: + + On Windows, macOS, and Linux, it is best to install Miniconda for the local user, which does not require administrator permissions and is the most robust type of installation. However, if you need to, you can install Miniconda system wide, which does require administrator permissions. + +.. tab-set:: + + .. tab-item:: Windows graphical installer + + #. :doc:`Download the installer. ` + #. (Optional) Verify your installer's SHA-256 checksum. This check proves that the installer you downloaded is the original one. + + a. Open PowerShell version 4.0 or later. For instructions for using Windows PowerShell 3.0 or older, see the `Cryptographic hash verification `_ instructions in the conda project documentation. + b. Run the following command, replacing ``filename`` with the path to your installer. + + .. code-block:: powershell + + Get-FileHash filename -Algorithm SHA256 + + c. Check the hash that appears against the hash listed next to the installer you downloaded. See :doc:`all Miniconda installer hashes here `. + + #. Double-click the ``.exe`` file. + #. Follow the instructions on the screen. If you are unsure about any setting, accept the defaults. You can change them later. + #. When the installation finishes, from the Start menu, open Anaconda Prompt. + #. Test your installation by running ``conda list``. If conda has been installed correctly, a list of installed packages appears. + + `More information on installing in silent mode on Windows is in the conda project documentation `_. + + .. tab-item:: macOS graphical installer + + #. :doc:`Download the installer. ` + #. (Optional) Verify your installer's SHA-256 checksum. This check proves that the installer you downloaded is the original one. + + a. Open a terminal application. + b. Run the following command, replacing ``filename`` with the path to your installer. + + .. code-block:: shell + + shasum -a 256 filename + + c. Check the hash that appears against the hash listed next to the installer you downloaded. See :doc:`all Miniconda installer hashes here `. + + #. Double-click the ``.pkg`` file. + #. Follow the instructions on the screen. If you are unsure about any setting, accept the defaults. You can change them later. + #. When the installation finishes, open your terminal application. + #. Test your installation by running ``conda list``. If conda has been installed correctly, a list of installed packages appears. + + `More information on installing in silent mode on macOS is in the conda project documentation `_. + + .. tab-item:: Linux installer + + #. :doc:`Download the installer. ` + #. (Optional) Verify your installer's SHA-256 checksum. This check proves that the installer you downloaded is the original one. + + a. Open your terminal. + b. Run the following command, replacing ``filename`` with the path to your installer. + + .. code-block:: shell + + sha256sum filename + + c. Check the hash that appears against the hash listed next to the installer you downloaded. See :doc:`all Miniconda installer hashes here `. + + #. In your terminal, run the following command, replacing ``filename`` with the path to your installer. + + .. code-block:: shell + + bash filename + + #. Follow the prompts on the installer screens. + + If you are unsure about any setting, accept the defaults. You can change them later. + + #. To make the changes take effect, close and then re-open your terminal window. + + #. Test your installation by running ``conda list``. If conda has been installed correctly, a list of installed packages appears. + + `For more information on installing in silent mode, see the macOS instructions in the conda project documentation `_. diff --git a/docs/source/miniconda-other-installer-links.rst b/docs/source/miniconda-other-installer-links.rst new file mode 100644 index 000000000..4d072c8cf --- /dev/null +++ b/docs/source/miniconda-other-installer-links.rst @@ -0,0 +1,71 @@ +.. This page is generated from the create_miniconda_installer_links_rst.py script. + To make changes, edit the miniconda-other-installer-links.rst.jinja2 file and execute the script + to re-generate miniconda-other-installer-links.rst + +================================================== +Latest Miniconda installer links by Python version +================================================== + +This list of Miniconda installers is for all supported versions of Python, separated by operating system. For an archive of Miniconda versions, see https://repo.anaconda.com/miniconda/. + +Windows installers +================== + +.. csv-table:: Windows + :header: Python version,Name,Size,SHA256 hash + :widths: 5, 10, 5, 80 + + Python 3.11,`Miniconda3 Windows 64-bit `_,73.2 MiB,``00e8370542836862d4c790aa8966f1d7344a8addd4b766004febcb23f40e2914`` + Python 3.10,`Miniconda3 Windows 64-bit `_,69.5 MiB,``e15638645b34921098a3f760fd8af07e53a427f59b99a0f049420a7751cbbc05`` + Python 3.9,`Miniconda3 Windows 64-bit `_,70.0 MiB,``f5738ced68d9ed82996575202dea9375c51fa6419a8e0f3456398c6557a87dc2`` + ,`Miniconda3 Windows 32-bit `_,67.8 MiB,``4fb64e6c9c28b88beab16994bfba4829110ea3145baa60bda5344174ab65d462`` + Python 3.8,`Miniconda3 Windows 64-bit `_,71.0 MiB,``585befbcd3a3b532d34bba8ab63818d6bc7cfde975b5d6a7fc49483b6a84f371`` + ,`Miniconda3 Windows 32-bit `_,66.8 MiB,``60cc5874b3cce9d80a38fb2b28df96d880e8e95d1b5848b15c20f1181e2807db`` + +macOS installers +================ + +.. csv-table:: macOS + :header: Python version,Name,Size,SHA256 hash + :widths: 5, 10, 5, 80 + + Python 3.11,`Miniconda3 macOS Intel x86 64-bit bash `_,69.6 MiB,``1622e7a0fa60a7d3d892c2d8153b54cd6ffe3e6b979d931320ba56bd52581d4b`` + ,`Miniconda3 macOS Intel x86 64-bit pkg `_,69.2 MiB,``2236a243b6cbe6f16ec324ecc9e631102494c031d41791b44612bbb6a7a1a6b4`` + ,`Miniconda3 macOS Apple M1 64-bit bash `_,68.6 MiB,``c8f436dbde130f171d39dd7b4fca669c223f130ba7789b83959adc1611a35644`` + ,`Miniconda3 macOS Apple M1 64-bit pkg `_,68.1 MiB,``837371f3b6e8ae2b65bdfc8370e6be812b564ff9f40bcd4eb0b22f84bf9b4fe5`` + Python 3.10,`Miniconda3 macOS Intel x86 64-bit bash `_,65.6 MiB,``13c57188a4bcb7462a7580c9ddf8ff2d301e353c835d33042a51a231667cf25d`` + ,`Miniconda3 macOS Intel x86 64-bit pkg `_,65.2 MiB,``7654b911e5649b051d9695e015bc2f24309fbade5d6298ba4c2f2d2118bd524a`` + ,`Miniconda3 macOS Apple M1 64-bit bash `_,64.6 MiB,``71b7ca2ae4068504f9c6dab30fd6e83694086241156af1e319d598befe0f3a26`` + ,`Miniconda3 macOS Apple M1 64-bit pkg `_,64.2 MiB,``57674d7cd22529e8425c76507ebbc4ebb6eb4c2fa36b9563439ceb88b5401765`` + Python 3.9,`Miniconda3 macOS Intel x86 64-bit bash `_,65.0 MiB,``dcbbdf92dc2954c79002b64ed53d3451e191dbdde0b30c67334f41dc6ca46ac1`` + ,`Miniconda3 macOS Intel x86 64-bit pkg `_,64.6 MiB,``dd4068750b09409436f5e4829007b06e1726c34acf1aff7248a73b2562b6599f`` + ,`Miniconda3 macOS Apple M1 64-bit bash `_,64.1 MiB,``1b10164086354b39a46ff928eef5797ff57e0fa9706ccaf7d4e621b416541479`` + ,`Miniconda3 macOS Apple M1 64-bit pkg `_,63.7 MiB,``c8fa540f615cf164f5a1200313be78654aaf074ca184bf22c4423e90802edd37`` + Python 3.8,`Miniconda3 macOS Intel x86 64-bit bash `_,66.5 MiB,``6dc8bfb3b382c31be1755545ae6afc5fbdf8a67726ffdb8a05b917204bd08779`` + ,`Miniconda3 macOS Intel x86 64-bit pkg `_,66.2 MiB,``ad702119896d6dbf25c945174b9999f5bff562e214654310d7f281aa18140349`` + ,`Miniconda3 macOS Apple M1 64-bit bash `_,65.7 MiB,``782bd1a401b20b41227a086adae98e270bbc942c3b7621788fb5574a9583142e`` + ,`Miniconda3 macOS Apple M1 64-bit pkg `_,65.3 MiB,``dd3eeb5b09f45aa5a1a4f921581582450f4c05ae35f7dd9f837a24f61f9442f5`` + +Linux installers +================ + +.. csv-table:: Linux + :header: Python version,Name,Size,SHA256 hash + :widths: 5, 10, 5, 80 + + Python 3.11,`Miniconda3 Linux 64-bit `_,98.4 MiB,``634d76df5e489c44ade4085552b97bebc786d49245ed1a830022b0b406de5817`` + ,`Miniconda3 Linux-aarch64 64-bit `_,76.4 MiB,``3962738cfac270ae4ff30da0e382aecf6b3305a12064b196457747b157749a7a`` + ,`Miniconda3 Linux-ppc64le 64-bit `_,77.3 MiB,``92237cb2a443dd15005ec004f2f744b14de02cd5513a00983c2f191eb43d1b29`` + ,`Miniconda3 Linux-s390x 64-bit `_,94.5 MiB,``221a4cd7f0a9275c3263efa07fa37385746de884f4306bb5d1fe5733ca770550`` + Python 3.10,`Miniconda3 Linux 64-bit `_,91.4 MiB,``ea5e6e8a3d5a0247b9df85382d27220fac8e59b5778fd313c5913879cd9baafc`` + ,`Miniconda3 Linux-aarch64 64-bit `_,72.9 MiB,``24f7fe91032538cf2d9748facabae346e45e46ca21bb5f2d5875b7865dca6fa4`` + ,`Miniconda3 Linux-ppc64le 64-bit `_,74.1 MiB,``3a76e4e400271d1589770dac8f696b03d1faf45fee57da38e8c399b6cb0daadb`` + ,`Miniconda3 Linux-s390x 64-bit `_,88.0 MiB,``7a65b8593db0ec4b561b9968daca7c7c4f5f95cb21fe717ba895fded924bc056`` + Python 3.9,`Miniconda3 Linux 64-bit `_,89.1 MiB,``9829d95f639bd0053b2ed06d1204e60644617bf37dd5cc57523732e0e8d64516`` + ,`Miniconda3 Linux-aarch64 64-bit `_,83.9 MiB,``ecc06a39bdf786ebb8325a2754690a808f873154719c97d10087ef0883b69e84`` + ,`Miniconda3 Linux-ppc64le 64-bit `_,84.5 MiB,``dc5aee01ee36a154b8070e6948b9a43773b6942476a144bc89e6135ac5beac58`` + ,`Miniconda3 Linux-s390x 64-bit `_,85.5 MiB,``40ece8784a9e7dd521ab354ffc816bb466842ae3eee681a93647945c5070c9b4`` + Python 3.8,`Miniconda3 Linux 64-bit `_,89.3 MiB,``e2a4438671e0e42c5bba14cb51de6ce9763938184d6ca2967340bbe972bbe7e6`` + ,`Miniconda3 Linux-aarch64 64-bit `_,72.7 MiB,``cd39b811ac9a2f9094c4dfff9ec0f7ec811d6ad7ede5ab3f1a31d330ab3a2c55`` + ,`Miniconda3 Linux-ppc64le 64-bit `_,74.1 MiB,``6fc3bf00d4fe0c724fab884d93b981acbc22bb8fc41c144df6d2fc080ff80e25`` + ,`Miniconda3 Linux-s390x 64-bit `_,85.8 MiB,``b840fd5a8474a3e6831cd50a64eadf73239c6ad7deeebf2c3d3fe366220b2722`` diff --git a/docs/source/miniconda-other-installer-links.rst.jinja2 b/docs/source/miniconda-other-installer-links.rst.jinja2 new file mode 100644 index 000000000..46462bbe1 --- /dev/null +++ b/docs/source/miniconda-other-installer-links.rst.jinja2 @@ -0,0 +1,26 @@ +.. This page is generated from the create_miniconda_installer_links_rst.py script. + To make changes, edit the miniconda-other-installer-links.rst.jinja2 file and execute the script + to re-generate miniconda-other-installer-links.rst + +================================================== +Latest Miniconda installer links by Python version +================================================== + +This list of Miniconda installers is for all supported versions of Python, separated by operating system. For an archive of Miniconda versions, see https://repo.anaconda.com/miniconda/. + +{%- for os in operating_systems %} +{% set heading = "{} installers".format(os) %} +{{ heading }} +{{ "=" * heading|length }} + +.. csv-table:: {{ os }} + :header: Python version,Name,Size,SHA256 hash + :widths: 5, 10, 5, 80 +{% for py_version in py_versions %} + {%- set py = py_version|replace(".", "") -%} + {%- for platform in platforms[os,py_version] %} + {% set first_column = "Python {}".format(py_version) if loop.first else "" -%} + {{ first_column }},`Miniconda3 {{ platform['description'] }} `_,{{ platform['size'] }},``{{ platform['hash'] }}`` + {%- endfor -%} +{%- endfor %} +{%- endfor %} diff --git a/docs/source/miniconda-other-resources.rst b/docs/source/miniconda-other-resources.rst new file mode 100644 index 000000000..e641a0f42 --- /dev/null +++ b/docs/source/miniconda-other-resources.rst @@ -0,0 +1,49 @@ +=============== +Other resources +=============== + + - `Miniconda Docker images `_ + - `Miniconda AWS images `_ + - `Installer and SHA256 hash archive `_ + - `conda release notes `_ + +Miniconda's installers contain the conda package manager, Python, and a few necessary packages. Once Miniconda is +installed, you can use the conda command to install any other packages and create environments. + +For example: + + .. container:: highlight-bash notranslate + + .. container:: highlight + + :: + + $ conda install numpy + ... + $ conda create -n py3k anaconda python=3 + ... + +There are two variants of the installer: Miniconda is Python 2 based, while Miniconda3 is Python 3 based. +Which Miniconda is installed only affects the root environment. Regardless of which version of Miniconda you +install, you can still use conda to install both Python 2.x and Python 3.x environments. + +However, Miniconda3 (the Python 3 version of Miniconda) will default to Python 3 when creating new environments +and building packages. + +For example, take the command below: + + .. container:: highlight-bash notranslate + + .. container:: highlight + + :: + + $ conda create -n myenv python + +Miniconda (Python 2 based) installs Python 2.7, while Miniconda3 (Python 3 based) installs Python 3.11 by default. +You can override the default by explicitly setting ``python=2`` or ``python=3`` when creating the environment. The +Miniconda version also determines the default value of ``CONDA_PY`` when using ``conda build``. + + .. note:: + If you already have Miniconda or Anaconda installed, and you just want to upgrade, you should + not use the installer. Just use ``conda update conda``. diff --git a/docs/source/miniconda-system-requirements.rst b/docs/source/miniconda-system-requirements.rst new file mode 100644 index 000000000..b00c4f61b --- /dev/null +++ b/docs/source/miniconda-system-requirements.rst @@ -0,0 +1,15 @@ +=================== +System requirements +=================== + +* License: Free use and redistribution under the terms of the `EULA for Miniconda `_. +* Operating system: Windows 10 or newer, 64-bit macOS 10.13+, or Linux, including Ubuntu, RedHat, CentOS 7+, and others. +* If your operating system is older than what is currently supported, you can find older versions of the Miniconda installers in our `archive `_ that might work for you. +* System architecture: Windows- 64-bit x86, 32-bit x86; macOS- 64-bit x86 & Apple M1 (ARM64); Linux- 64-bit x86, 64-bit aarch64 (AWS Graviton2), 64-bit IBM Power8/Power9, s390x (Linux on IBM Z & LinuxONE). +* The ``linux-aarch64`` Miniconda installer requires ``glibc >=2.26`` and thus will **not** work with CentOS 7, Ubuntu 16.04, or Debian 9 ("stretch"). +* Minimum 400 MB disk space to download and install. + +On Windows, macOS, and Linux, it is best to install Miniconda for the local user, +which does not require administrator permissions and is the most robust type of +installation. However, if you need to, you can install Miniconda system wide, +which does require administrator permissions. diff --git a/docs/source/miniconda.rst b/docs/source/miniconda.rst index 8c50389db..b503b0e98 100644 --- a/docs/source/miniconda.rst +++ b/docs/source/miniconda.rst @@ -1,44 +1,29 @@ -.. This page is generated from the create_miniconda_rst.py script. - To make changes edit the miniconda.rst.jinja2 file and execute the script - to re-generate miniconda.rst - ========= 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 depend -on, and a small number of other useful packages, including pip, zlib and a -few others. Use the ``conda install`` command to install 720+ additional conda -packages from the Anaconda repository. - -`See if Miniconda is right for you `_. - -System requirements -=================== - -* License: Free use and redistribution under the terms of the `EULA for Miniconda `_. -* Operating system: Windows 10 or newer, 64-bit macOS 10.13+, or Linux, including Ubuntu, RedHat, CentOS 7+, and others. -* If your operating system is older than what is currently supported, you can find older versions of the Miniconda installers in our `archive `_ that might work for you. -* System architecture: Windows- 64-bit x86, 32-bit x86; macOS- 64-bit x86 & Apple M1 (ARM64); Linux- 64-bit x86, 64-bit aarch64 (AWS Graviton2), 64-bit IBM Power8/Power9, s390x (Linux on IBM Z & LinuxONE). -* The ``linux-aarch64`` Miniconda installer requires ``glibc >=2.26`` and thus will **not** work with CentOS 7, Ubuntu 16.04, or Debian 9 ("stretch"). -* Minimum 400 MB disk space to download and install. - -On Windows, macOS, and Linux, it is best to install Miniconda for the local user, -which does not require administrator permissions and is the most robust type of -installation. However, if you need to, you can install Miniconda system wide, -which does require administrator permissions. - -Installing -========== -- :doc:`See hashes for all Miniconda installers <../miniconda_hashes>`. -- `Verify your installation `_. -- `Installation - instructions `__. - -Latest Miniconda Installer Links +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 23.5.2 Python 3.11.3 released July 13, 2023 :header: Platform,Name,SHA256 hash :widths: 5, 10, 80 @@ -54,142 +39,64 @@ Latest Miniconda Installer Links ,`Miniconda3 Linux-ppc64le 64-bit `_,``92237cb2a443dd15005ec004f2f744b14de02cd5513a00983c2f191eb43d1b29`` ,`Miniconda3 Linux-s390x 64-bit `_,``221a4cd7f0a9275c3263efa07fa37385746de884f4306bb5d1fe5733ca770550`` -Windows installers -================== - -.. csv-table:: Windows - :header: Python version,Name,Size,SHA256 hash - :widths: 5, 10, 5, 80 - - Python 3.11,`Miniconda3 Windows 64-bit `_,73.2 MiB,``00e8370542836862d4c790aa8966f1d7344a8addd4b766004febcb23f40e2914`` - Python 3.10,`Miniconda3 Windows 64-bit `_,69.5 MiB,``e15638645b34921098a3f760fd8af07e53a427f59b99a0f049420a7751cbbc05`` - Python 3.9,`Miniconda3 Windows 64-bit `_,70.0 MiB,``f5738ced68d9ed82996575202dea9375c51fa6419a8e0f3456398c6557a87dc2`` - ,`Miniconda3 Windows 32-bit `_,67.8 MiB,``4fb64e6c9c28b88beab16994bfba4829110ea3145baa60bda5344174ab65d462`` - Python 3.8,`Miniconda3 Windows 64-bit `_,71.0 MiB,``585befbcd3a3b532d34bba8ab63818d6bc7cfde975b5d6a7fc49483b6a84f371`` - ,`Miniconda3 Windows 32-bit `_,66.8 MiB,``60cc5874b3cce9d80a38fb2b28df96d880e8e95d1b5848b15c20f1181e2807db`` - -macOS installers -================ - -.. csv-table:: macOS - :header: Python version,Name,Size,SHA256 hash - :widths: 5, 10, 5, 80 - - Python 3.11,`Miniconda3 macOS Intel x86 64-bit bash `_,69.6 MiB,``1622e7a0fa60a7d3d892c2d8153b54cd6ffe3e6b979d931320ba56bd52581d4b`` - ,`Miniconda3 macOS Intel x86 64-bit pkg `_,69.2 MiB,``2236a243b6cbe6f16ec324ecc9e631102494c031d41791b44612bbb6a7a1a6b4`` - ,`Miniconda3 macOS Apple M1 64-bit bash `_,68.6 MiB,``c8f436dbde130f171d39dd7b4fca669c223f130ba7789b83959adc1611a35644`` - ,`Miniconda3 macOS Apple M1 64-bit pkg `_,68.1 MiB,``837371f3b6e8ae2b65bdfc8370e6be812b564ff9f40bcd4eb0b22f84bf9b4fe5`` - Python 3.10,`Miniconda3 macOS Intel x86 64-bit bash `_,65.6 MiB,``13c57188a4bcb7462a7580c9ddf8ff2d301e353c835d33042a51a231667cf25d`` - ,`Miniconda3 macOS Intel x86 64-bit pkg `_,65.2 MiB,``7654b911e5649b051d9695e015bc2f24309fbade5d6298ba4c2f2d2118bd524a`` - ,`Miniconda3 macOS Apple M1 64-bit bash `_,64.6 MiB,``71b7ca2ae4068504f9c6dab30fd6e83694086241156af1e319d598befe0f3a26`` - ,`Miniconda3 macOS Apple M1 64-bit pkg `_,64.2 MiB,``57674d7cd22529e8425c76507ebbc4ebb6eb4c2fa36b9563439ceb88b5401765`` - Python 3.9,`Miniconda3 macOS Intel x86 64-bit bash `_,65.0 MiB,``dcbbdf92dc2954c79002b64ed53d3451e191dbdde0b30c67334f41dc6ca46ac1`` - ,`Miniconda3 macOS Intel x86 64-bit pkg `_,64.6 MiB,``dd4068750b09409436f5e4829007b06e1726c34acf1aff7248a73b2562b6599f`` - ,`Miniconda3 macOS Apple M1 64-bit bash `_,64.1 MiB,``1b10164086354b39a46ff928eef5797ff57e0fa9706ccaf7d4e621b416541479`` - ,`Miniconda3 macOS Apple M1 64-bit pkg `_,63.7 MiB,``c8fa540f615cf164f5a1200313be78654aaf074ca184bf22c4423e90802edd37`` - Python 3.8,`Miniconda3 macOS Intel x86 64-bit bash `_,66.5 MiB,``6dc8bfb3b382c31be1755545ae6afc5fbdf8a67726ffdb8a05b917204bd08779`` - ,`Miniconda3 macOS Intel x86 64-bit pkg `_,66.2 MiB,``ad702119896d6dbf25c945174b9999f5bff562e214654310d7f281aa18140349`` - ,`Miniconda3 macOS Apple M1 64-bit bash `_,65.7 MiB,``782bd1a401b20b41227a086adae98e270bbc942c3b7621788fb5574a9583142e`` - ,`Miniconda3 macOS Apple M1 64-bit pkg `_,65.3 MiB,``dd3eeb5b09f45aa5a1a4f921581582450f4c05ae35f7dd9f837a24f61f9442f5`` - -Linux installers -================ - -.. csv-table:: Linux - :header: Python version,Name,Size,SHA256 hash - :widths: 5, 10, 5, 80 - - Python 3.11,`Miniconda3 Linux 64-bit `_,98.4 MiB,``634d76df5e489c44ade4085552b97bebc786d49245ed1a830022b0b406de5817`` - ,`Miniconda3 Linux-aarch64 64-bit `_,76.4 MiB,``3962738cfac270ae4ff30da0e382aecf6b3305a12064b196457747b157749a7a`` - ,`Miniconda3 Linux-ppc64le 64-bit `_,77.3 MiB,``92237cb2a443dd15005ec004f2f744b14de02cd5513a00983c2f191eb43d1b29`` - ,`Miniconda3 Linux-s390x 64-bit `_,94.5 MiB,``221a4cd7f0a9275c3263efa07fa37385746de884f4306bb5d1fe5733ca770550`` - Python 3.10,`Miniconda3 Linux 64-bit `_,91.4 MiB,``ea5e6e8a3d5a0247b9df85382d27220fac8e59b5778fd313c5913879cd9baafc`` - ,`Miniconda3 Linux-aarch64 64-bit `_,72.9 MiB,``24f7fe91032538cf2d9748facabae346e45e46ca21bb5f2d5875b7865dca6fa4`` - ,`Miniconda3 Linux-ppc64le 64-bit `_,74.1 MiB,``3a76e4e400271d1589770dac8f696b03d1faf45fee57da38e8c399b6cb0daadb`` - ,`Miniconda3 Linux-s390x 64-bit `_,88.0 MiB,``7a65b8593db0ec4b561b9968daca7c7c4f5f95cb21fe717ba895fded924bc056`` - Python 3.9,`Miniconda3 Linux 64-bit `_,89.1 MiB,``9829d95f639bd0053b2ed06d1204e60644617bf37dd5cc57523732e0e8d64516`` - ,`Miniconda3 Linux-aarch64 64-bit `_,83.9 MiB,``ecc06a39bdf786ebb8325a2754690a808f873154719c97d10087ef0883b69e84`` - ,`Miniconda3 Linux-ppc64le 64-bit `_,84.5 MiB,``dc5aee01ee36a154b8070e6948b9a43773b6942476a144bc89e6135ac5beac58`` - ,`Miniconda3 Linux-s390x 64-bit `_,85.5 MiB,``40ece8784a9e7dd521ab354ffc816bb466842ae3eee681a93647945c5070c9b4`` - Python 3.8,`Miniconda3 Linux 64-bit `_,89.3 MiB,``e2a4438671e0e42c5bba14cb51de6ce9763938184d6ca2967340bbe972bbe7e6`` - ,`Miniconda3 Linux-aarch64 64-bit `_,72.7 MiB,``cd39b811ac9a2f9094c4dfff9ec0f7ec811d6ad7ede5ab3f1a31d330ab3a2c55`` - ,`Miniconda3 Linux-ppc64le 64-bit `_,74.1 MiB,``6fc3bf00d4fe0c724fab884d93b981acbc22bb8fc41c144df6d2fc080ff80e25`` - ,`Miniconda3 Linux-s390x 64-bit `_,85.8 MiB,``b840fd5a8474a3e6831cd50a64eadf73239c6ad7deeebf2c3d3fe366220b2722`` - -Release Notes -============= -- :doc:`Release Notes for Miniconda <../miniconda_release_notes>` - -Other resources -=============== - - - `Miniconda Docker - images `__ - - `Miniconda AWS - images `__ - - `Archive and SHA256 sums for the - installers `__ - - `conda change - log `__ - - These Miniconda installers contain the conda - package manager and Python. Once Miniconda is - installed, you can use the conda command to install - any other packages and create environments, etc. - For example: - - .. container:: highlight-bash notranslate - - .. container:: highlight - - :: - - $ conda install numpy - ... - $ conda create -n py3k anaconda python=3 - ... - - There are two variants of the installer: Miniconda - is Python 2 based and Miniconda3 is Python 3 based. - Note that the choice of which Miniconda is - installed only affects the root environment. - Regardless of which version of Miniconda you - install, you can still install both Python 2.x and - Python 3.x environments. - - The other difference is that the Python 3 version - of Miniconda will default to Python 3 when creating - new environments and building packages. So for - instance, the behavior of: - - .. container:: highlight-bash notranslate - - .. container:: highlight - - :: - - $ conda create -n myenv python - - will be to install Python 2.7 with the Python 2 - Miniconda and to install Python 3.10 with the Python - 3 Miniconda. You can override the default by - explicitly setting ``python=2`` or ``python=3``. It - also determines the default value of ``CONDA_PY`` - when using ``conda build``. - - .. note:: - If you already have Miniconda or Anaconda - installed, and you just want to upgrade, you should - not use the installer. Just use ``conda update``. - - For instance: - - .. container:: highlight-bash notranslate - - .. container:: highlight - - :: - - $ conda update conda +.. _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 - will update conda. + ~/miniconda3/bin/conda init bash + ~/miniconda3/bin/conda init zsh diff --git a/docs/source/miniconda.rst.jinja2 b/docs/source/miniconda.rst.jinja2 index fa30302d1..7524c4e2d 100644 --- a/docs/source/miniconda.rst.jinja2 +++ b/docs/source/miniconda.rst.jinja2 @@ -1,44 +1,29 @@ -.. This page is generated from the create_miniconda_rst.py script. - To make changes edit the miniconda.rst.jinja2 file and execute the script - to re-generate miniconda.rst - ========= 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 depend -on, and a small number of other useful packages, including pip, zlib and a -few others. Use the ``conda install`` command to install 720+ additional conda -packages from the Anaconda repository. - -`See if Miniconda is right for you `_. - -System requirements -=================== - -* License: Free use and redistribution under the terms of the `EULA for Miniconda `_. -* Operating system: Windows 10 or newer, 64-bit macOS 10.13+, or Linux, including Ubuntu, RedHat, CentOS 7+, and others. -* If your operating system is older than what is currently supported, you can find older versions of the Miniconda installers in our `archive `_ that might work for you. -* System architecture: Windows- 64-bit x86, 32-bit x86; macOS- 64-bit x86 & Apple M1 (ARM64); Linux- 64-bit x86, 64-bit aarch64 (AWS Graviton2), 64-bit IBM Power8/Power9, s390x (Linux on IBM Z & LinuxONE). -* The ``linux-aarch64`` Miniconda installer requires ``glibc >=2.26`` and thus will **not** work with CentOS 7, Ubuntu 16.04, or Debian 9 ("stretch"). -* Minimum 400 MB disk space to download and install. - -On Windows, macOS, and Linux, it is best to install Miniconda for the local user, -which does not require administrator permissions and is the most robust type of -installation. However, if you need to, you can install Miniconda system wide, -which does require administrator permissions. - -Installing -========== -- :doc:`See hashes for all Miniconda installers <../miniconda_hashes>`. -- `Verify your installation `_. -- `Installation - instructions `__. - -Latest Miniconda Installer Links +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 @@ -47,99 +32,66 @@ Latest Miniconda Installer Links {% set first_column = os if loop.first else "" -%} {{ first_column }},`Miniconda3 {{ platform['description'] }} `_,``{{ platform['hash'] }}`` {%- endfor -%} -{%- endfor -%} - -{%- for os in operating_systems %} -{% set heading = "{} installers".format(os) %} -{{ heading }} -{{ "=" * heading|length }} - -.. csv-table:: {{ os }} - :header: Python version,Name,Size,SHA256 hash - :widths: 5, 10, 5, 80 -{% for py_version in py_versions %} - {%- set py = py_version|replace(".", "") -%} - {%- for platform in platforms[os,py_version] %} - {% set first_column = "Python {}".format(py_version) if loop.first else "" -%} - {{ first_column }},`Miniconda3 {{ platform['description'] }} `_,{{ platform['size'] }},``{{ platform['hash'] }}`` - {%- endfor -%} -{%- endfor %} {%- endfor %} -Release Notes -============= -- :doc:`Release Notes for Miniconda <../miniconda_release_notes>` +.. _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:: -Other resources -=============== + .. tab-item:: Windows - - `Miniconda Docker - images `__ - - `Miniconda AWS - images `__ - - `Archive and SHA256 sums for the - installers `__ - - `conda change - log `__ + 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. - These Miniconda installers contain the conda - package manager and Python. Once Miniconda is - installed, you can use the conda command to install - any other packages and create environments, etc. - For example: + .. code-block:: none - .. container:: highlight-bash notranslate + curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o miniconda.exe + start /wait "" miniconda.exe /S + del miniconda.exe - .. container:: highlight + 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 install numpy - ... - $ conda create -n py3k anaconda python=3 - ... + conda init cmd.exe + conda init powershell - There are two variants of the installer: Miniconda - is Python 2 based and Miniconda3 is Python 3 based. - Note that the choice of which Miniconda is - installed only affects the root environment. - Regardless of which version of Miniconda you - install, you can still install both Python 2.x and - Python 3.x environments. + .. tab-item:: macOS - The other difference is that the Python 3 version - of Miniconda will default to Python 3 when creating - new environments and building packages. So for - instance, the behavior of: + 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. - .. container:: highlight-bash notranslate + .. code-block:: bash - .. container:: highlight + 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: - $ conda create -n myenv python + .. code-block:: bash - will be to install Python 2.7 with the Python 2 - Miniconda and to install Python 3.10 with the Python - 3 Miniconda. You can override the default by - explicitly setting ``python=2`` or ``python=3``. It - also determines the default value of ``CONDA_PY`` - when using ``conda build``. + ~/miniconda3/bin/conda init bash + ~/miniconda3/bin/conda init zsh - .. note:: - If you already have Miniconda or Anaconda - installed, and you just want to upgrade, you should - not use the installer. Just use ``conda update``. + .. tab-item:: Linux - For instance: + 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. - .. container:: highlight-bash notranslate + .. code-block:: bash - .. container:: highlight + 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: - $ conda update conda + .. code-block:: bash - will update conda. + ~/miniconda3/bin/conda init bash + ~/miniconda3/bin/conda init zsh diff --git a/docs/source/miniconda_release_notes.rst b/docs/source/miniconda_release_notes.rst index d15ab15cf..f42ae496e 100644 --- a/docs/source/miniconda_release_notes.rst +++ b/docs/source/miniconda_release_notes.rst @@ -1,5 +1,5 @@ ======================= -Miniconda Release Notes +Miniconda release notes ======================= Miniconda 23.5.2 (July 13, 2023) diff --git a/docs/source/miniconda_release_notes.rst.jinja2 b/docs/source/miniconda_release_notes.rst.jinja2 index 24a3835eb..588b0d8aa 100644 --- a/docs/source/miniconda_release_notes.rst.jinja2 +++ b/docs/source/miniconda_release_notes.rst.jinja2 @@ -1,5 +1,5 @@ ======================= -Miniconda Release Notes +Miniconda release notes ======================= {% for release in release_info %} diff --git a/news/842-add-miniconda-install-codeblocks b/news/842-add-miniconda-install-codeblocks new file mode 100644 index 000000000..90f867650 --- /dev/null +++ b/news/842-add-miniconda-install-codeblocks @@ -0,0 +1,19 @@ +### Enhancements + +* + +### Bug fixes + +* + +### Deprecations + +* + +### Docs + +* Add quickstart command line install instructions to Miniconda docs homepage. (#876) + +### Other + +* diff --git a/news/875-update-miniconda-docs b/news/875-update-miniconda-docs new file mode 100644 index 000000000..5bbd0b20b --- /dev/null +++ b/news/875-update-miniconda-docs @@ -0,0 +1,19 @@ +### Enhancements + +* + +### Bug fixes + +* + +### Deprecations + +* + +### Docs + +* Update and simplify Miniconda docs homepage, separating information most information onto their own pages. (#876) + +### Other + +* diff --git a/requirements.txt b/requirements.txt index b9b396a25..292c3b21a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ Sphinx sphinx-sitemap==2.2.0 +sphinx-design