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

O módulo de acesso aos dados, arcpy.da, é um módulo de Python para trabalhar com dados. Permite o controle da sessão de edição, operação de edição, suporte melhorado ao cursor (incluindo desempenho mais rápido), funções para converter tabelas e classes de feição de e para vetores NumPy e suporte para versionamento, réplicas, domínios e fluxos de trabalho de subtipos.

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

The Image Analysis module, arcpy.ia, is a Python module for managing and processing imagery and raster data. The module also includes functionality provided by the ArcGIS Image Analyst extension, such as all of the geoprocessing functions, as well as advanced functions and classes that allow you to automate your raster processing workflows.

Learn more about the Image Analysis module

Mapping

Arcpy.mp é um submódulo de Python que faz parte do pacote de site do ArcPy. É instalado com ArcGIS Pro e está disponível para todas as licenças. Ele foi projetado principalmente para manipular o conteúdo de projetos existentes (.aprx) e arquivos de camada (.lyrou .lyrx). Também fornece funções para automatizar a exportação e impressão. Arcpy.mp pode ser utilizado para automatizar a produção de mapas e é exigido para criar livros de mapas completos, pois inclui funções para exportar, criar e gerenciar documentos PDF.

Learn more about the Mapping module

Anotação:
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

O módulo Network Analyst, arcpy.nax, é um módulo Python moderno e fácil de utilizar para trabalhar com a funcionalidade da análise de rede fornecida com a extensão extensão ArcGIS Network Analyst. Fornece acesso para o seguinte:

  • Classes que permitem a você executar todas as análises de rede suportadas
  • Classes que permitem a você trabalhar com informações relacionadas à conectividade de vários elementos que compõem um conjunto de dados de rede
  • Ferramentas de geoprocessamento que permitem a você pré-processar entradas, compartilhar seus resultados de análise ou trabalhar com conjuntos de dados de rede
  • Classes e funções auxiliares que você pode utilizar para trabalhar com determinados tipos de dados utilizados pelas classes que permitem a você executar análises de rede

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.

O módulo de compartilhamento permite a você criar um rascunho de compartilhamento a partir de um mapa em um projeto do ArcGIS Pro , que pode então ser compartilhado no ArcGIS Enterprise, ArcGIS Online, ou ArcGIS Server. Um rascunho de compartilhamento é um conjunto de propriedades configurável para uma camada da web. Criar um rascunho de compartilhamento é a primeira etapa para automatizar a publicação de um mapa, camada, tabela ou lista de camadas e tabelas em umacamada da web utilizando Python. O rascunho de compartilhamento pode então ser salvo como um arquivo de rascunho da definição de serviço (.sddraft) .

Learn more about the Sharing module

Spatial Analyst

O módulo Spatial Analyst, arcpy.sa, é um módulo de Python para analisar dados raster com a funcionalidade fornecida pela extensão do ArcGIS Spatial Analyst. Fornece acesso a todas as ferramentas de geoprocessamento disponíveis na caixa de ferramentas Spatial Analyst como também outras funções e classes que permitem que você automatize seus fluxos de trabalho de processamento de raster.

Learn more about the Spatial Analyst module

Anotação:

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.