{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {},
  "_ordered_sections": [],
  "item_file": null,
  "item_line": null,
  "item_type": null,
  "aliases": [],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": null,
  "references": null,
  "qa": "user_guide:install",
  "arbitrary": [
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "First, you need to have the Python language installed.   Two popular routes are the pip-based   "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "Python.org installers"
                        }
                      ],
                      "url": "https://www.python.org/downloads/",
                      "title": ""
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "   and the conda-based   "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "miniforge"
                        }
                      ],
                      "url": "https://github.com/conda-forge/miniforge",
                      "title": ""
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Install "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "scikit-image"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " via "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "pip <#install-via-pip>",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " or "
                    },
                    {
                      "__type": "InlineRole",
                      "__tag": 4003,
                      "value": "conda <#install-via-conda>",
                      "domain": null,
                      "role": null,
                      "inventory": null
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ", as appropriate."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Or, "
                    },
                    {
                      "__type": "CrossRef",
                      "__tag": 4002,
                      "value": "build the package from source",
                      "reference": {
                        "__type": "LocalRef",
                        "__tag": 4022,
                        "kind": "docs",
                        "path": "/development/contribute"
                      },
                      "kind": "docs"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ".   Do this if you'd like to contribute to development."
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Windows 64-bit on x86 processors"
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "macOS on x86 and ARM (M1, etc.) processors"
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "Linux 64-bit on x86 and ARM processors"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "While we do not officially support other platforms, you could still try "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "building from source",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "docs",
                "path": "/development/contribute"
              },
              "kind": "docs"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "To see whether "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikit-image"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is already installed or to check if an install has worked, run the following in a Python shell or Jupyter notebook:"
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "import skimage as ski\nprint(ski.__version__)",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "or, from the command line:"
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "python -c \"import skimage; print(skimage.__version__)\"",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "(Try "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "python3"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " if "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "python"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is unsuccessful.)"
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "You'll see the version number if "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikit-image"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is installed and an error message otherwise."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Prerequisites to a pip install: you must be able to use "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "pip"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " on your command line to install packages."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "We strongly recommend the use of a "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "virtual environment"
                }
              ],
              "url": "https://towardsdatascience.com/virtual-environments-104c62d48c54?gi=2532aa12906#ee81",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". A virtual environment creates a clean Python environment that does not interfere with the existing system installation, can be easily removed, and contains only the package versions your application needs."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "To install the current "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikit-image"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " you'll need at least Python 3.12. If your Python is older, pip will find the most recent compatible version."
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "# Update pip\npython -m pip install -U pip\n\n# Install scikit-image\npython -m pip install -U scikit-image",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Some additional dependencies are required to access all example datasets in "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "skimage.data"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". Install them using:"
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "python -m pip install -U scikit-image[data]",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "To install optional scientific Python packages that expand "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikit-image"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "'s capabilities to include, e.g., parallel processing, use:"
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "python -m pip install -U scikit-image[optional]",
          "execution_status": null
        },
        {
          "__type": "Admonition",
          "__tag": 4056,
          "kind": "warning",
          "base_type": "warning",
          "children": [
            {
              "__type": "AdmonitionTitle",
              "__tag": 4055,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "warning "
                }
              ]
            },
            {
              "__type": "Paragraph",
              "__tag": 4045,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "Do not use the command "
                },
                {
                  "__type": "InlineCode",
                  "__tag": 4051,
                  "value": "sudo"
                },
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": " and "
                },
                {
                  "__type": "InlineCode",
                  "__tag": 4051,
                  "value": "pip"
                },
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": " together as "
                },
                {
                  "__type": "InlineCode",
                  "__tag": 4051,
                  "value": "pip"
                },
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": " may overwrite critical system libraries."
                }
              ]
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "We recommend "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "miniforge"
                }
              ],
              "url": "https://github.com/conda-forge/miniforge",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", a minimal distribution that makes use of "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "conda-forge"
                }
              ],
              "url": "https://conda-forge.org",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ". It installs Python and provides virtual environments."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Once you have your conda environment set up, install "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikit-image"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " with:"
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "conda install scikit-image",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Using a package manager ("
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "apt"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "dnf"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", etc.) to install "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikit-image"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " or other Python packages is not your best option, since you're likely to get an older version. It also becomes harder to install other Python packages not provided by the package manager."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Some of our example images (in "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "skimage.data"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ") are hosted online and are not installed by default. These images are downloaded upon first access. If you prefer to download all demo datasets, so they can be accessed offline, ensure that "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "pooch"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is installed, then run:"
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": "python -c 'import skimage as ski; ski.data.download_all()'",
          "execution_status": null
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "If you still have questions, reach out through"
            }
          ]
        },
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "our "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "user forum"
                        }
                      ],
                      "url": "https://forum.image.sc/tags/scikit-image",
                      "title": ""
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "our "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "developer forum"
                        }
                      ],
                      "url": "https://discuss.scientific-python.org/c/contributor/skimage",
                      "title": ""
                    }
                  ]
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "our "
                    },
                    {
                      "__type": "Link",
                      "__tag": 4049,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "chat channel"
                        }
                      ],
                      "url": "https://skimage.zulipchat.com/",
                      "title": ""
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "To suggest a change in these instructions, "
            },
            {
              "__type": "Link",
              "__tag": 4049,
              "children": [
                {
                  "__type": "Text",
                  "__tag": 4046,
                  "value": "please open an issue on GitHub"
                }
              ],
              "url": "https://github.com/scikit-image/scikit-image/issues/new",
              "title": ""
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "See the "
            },
            {
              "__type": "CrossRef",
              "__tag": 4002,
              "value": "contributing guide",
              "reference": {
                "__type": "LocalRef",
                "__tag": 4022,
                "kind": "docs",
                "path": "/development/contribute"
              },
              "kind": "docs"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " for instructions on setting up a development environment and contributing to scikit-image."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    }
  ],
  "local_refs": []
}