Create an isolated Python virtual environment with all rgee dependencies. ee_install realize the following six (6) tasks:

  • 1. If you do not count with a Python environment, it will display an interactive menu to install Miniconda (a free minimal installer for conda).

  • 2. If it exists, delete the previous Python environment specified in the py_env argument.

  • 3. Create a new Python environment (See py_env) argument.

  • 4. Set the environment variable EARTHENGINE_PYTHON and EARTHENGINE_ENV. It is used to define RETICULATE_PYTHON when the library is loaded. See this article for further details.

  • 5. Install rgee Python dependencies. Using reticulate::py_install.

  • 6. Interactive menu to confirm if restart the R session to see changes.

ee_install(
  py_env = "rgee",
  earthengine_version = ee_version(),
  python_version = "3.8",
  confirm = interactive()
)

Arguments

py_env

Character. The name, or full path, of the Python environment to be used by rgee.

earthengine_version

Character. The Earth Engine Python API version to install. By default rgee::ee_version().

python_version

Only windows users. The Python version to be used in this conda environment. When NULL, the default python package will be used instead. For example, use python_version = "3.6" to request that the conda environment be created with a copy of Python 3.6.

confirm

Logical. Confirm before restarting R?.

Value

No return value, called for installing non-R dependencies.

See also

Other ee_install functions: ee_install_set_pyenv(), ee_install_upgrade()

Examples

if (FALSE) {
library(rgee)
# ee_install()
}