Skip To Content

Use ArcPy in a notebook

Several ArcPy modules are available in ArcGIS Notebooks through the Advanced notebook runtime.

With the ArcPy site package, you can perform geographic data analysis, conversion, and management. ArcPy allows you to programmatically run all ArcGIS standard geoprocessing tools and provides helper functions and classes.

Learn more about ArcPy

To use ArcPy in your notebook, ArcGIS Notebook Server must be licensed with the Advanced license, and users must have the privilege to create and run ArcPy notebooks.

ArcPy modules

The modules described below are included with ArcPy in ArcGIS Notebook Server.

Data Access

The data access module, arcpy.da, is a Python module for working with data. It allows control of the edit session, edit operation, improved cursor support (including faster performance), functions for converting tables and feature classes to and from NumPy arrays, and support for versioning, replicas, domains, and subtypes workflows.

Learn more about the Data Access module

Geocoding

The Geocoding module, arcpy.geocoding, allows you to explore and set locator properties and automate geocoding workflows. Geocoding is the process of transforming a description of a location—such as a pair of coordinates, an address, or a name of a place—to a location on the earth's surface. A locator is the tool used to perform geocoding operations. With this module, you can view and modify properties on the locator to tune it to your specific geocoding needs by customizing it for performance or quality. You can also use this module to perform various geocoding operations, including finding the location of a place or address, finding the closest place or address to a given location, or generating a set of autocomplete suggestions for partial input.

Learn more about the Geocoding module

Image Analysis

El módulo Análisis de imagen, arcpy.ia, es un módulo de Python para administrar y procesar imágenes y datos ráster. El módulo también incluye la funcionalidad que proporciona la extensión Image Analyst de ArcGIS, como todas las funciones de geoprocesamiento, además de clases y funciones avanzadas que permiten automatizar sus flujos de trabajo de procesamiento ráster.

Learn more about the Image Analysis module

Mapping

Arcpy.mp es un submódulo de Python que forma parte del paquete del sitio de ArcPy. Se instala con ArcGIS Pro y está disponible con todas las licencias. Se ha diseñado principalmente para manipular el contenido de los proyectos existentes (.aprx) y los archivos de capas (.lyr o .lyrx). También proporciona funciones para automatizar la exportación y la impresión. Arcpy.mp se puede utilizar para automatizar la producción de mapas y es necesario para crear libros de mapas completos porque incluye funciones para exportar, crear y administrar documentos PDF.

Learn more about the Mapping module

Nota:
The arcpy.mp module is used in ArcGIS Pro; the arcpy.mapping module is used in ArcGIS Desktop.

Metadata

The Metadata module, arcpy.metadata, is a Python module for accessing and managing an item's metadata. You can explore information describing your maps and data and automate your workflows, particularly for managing standards-compliant geospatial metadata.

Learn more about the Metadata module

Network Analyst

El módulo de Network Analyst, arcpy.nax, es un módulo de Python moderno y fácil de usar para trabajar con funcionalidades de análisis de red que se proporcionan con la Extensión ArcGIS Network Analyst. Proporciona acceso a lo siguiente:

  • Clases que permiten realizar todos los análisis de red admitidos.
  • Clases que permiten trabajar con información relacionada con la conectividad de varios elementos que componen un dataset de red.
  • Herramientas de geoprocesamiento que permiten procesar previamente entradas, compartir los resultados de su análisis o trabajar con datasets de red.
  • Funciones y clases del asistente que puede utilizar para trabajar con determinados tipos de datos utilizados por las clases que permiten realizar análisis de red.

Learn more about the Network Analyst module

The legacy module arcpy.na is not included with ArcGIS Notebooks.

Sharing

The arcpy.sharing module shares web layers using Python.

El módulo de uso compartido le permite crear un borrador de uso compartido desde un mapa en un proyecto de ArcGIS Pro, que después se puede compartir en ArcGIS Enterprise, ArcGIS Online o ArcGIS Server. Un borrador de uso compartuido es un conjunto configurable de propiedades para una capa web. La creación de un borrador de uso compartido es el primer paso para automatizar la publicación de un mapa, capa, tabla o lista de capas y tablas en una capa web mediante Python. Después, el borrador de uso compartido se puede guardar como un archivo de borrador de definición de servicio (.sddraft).

Learn more about the Sharing module

Spatial Analyst

The Spatial Analyst module is a Python module for analyzing raster data with the functionality provided by the ArcGIS Spatial Analyst extension. It provides access to all the geoprocessing tools available in the Spatial Analyst toolbox as well as other helper functions and classes that allow you to more easily automate your workflows using Python.

Learn more about the Spatial Analyst module

Nota:

The Workflow Manager (arcpy.wmx) module is not included with ArcGIS Notebook Server.

Get started with ArcPy in a notebook

To use ArcPy in a notebook, import its library by running a cell with the following lines:

import arcpy
arcpy.GetInstallInfo()['Version']

View the sample notebooks that are included with ArcGIS Notebook Server to learn how ArcPy can be used in your own notebooks.