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

Le module Analyse d’image, arcpy.ia, est un module Python qui permet de gérer et de traiter des données d’imagerie et raster. Le module inclut également des fonctions fournies par l’extension Image Analyst d’ArcGIS, telles que toutes les fonctionnalités de géotraitement, ainsi que des fonctionnalités et classes avancées qui vous permettent d’automatiser vos processus de traitement raster.

Learn more about the Image Analysis module

Mapping

Arcpy.mp est un sous-module Python appartenant au paquetage de site ArcPy. Il est installé avec ArcGIS Pro et accessible à tous les types de licences. Il a été conçu dans le but de manipuler le contenu de projets (.aprx) et de fichiers de couche (.lyr ou .lyrx) existants. Il propose également des fonctions permettant d'automatiser l'exportation et l'impression. Arcpy.mp permet d'automatiser la production des cartes. Il doit être utilisé pour générer des atlas complets, car il comprend des fonctions d'exportation, de création et de gestion des documents PDF.

Learn more about the Mapping module

Remarque :
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

Le module Network Analyst, arcpy.nax, est un module Python moderne et convivial prévu pour utiliser la fonctionnalité d’analyse de réseau fournie par l’Extension ArcGIS Network Analyst. Il permet d'accéder aux options suivantes :

  • des classes qui vous permettent d'effectuer toutes les analyses du réseau prises en charge
  • des classes qui vous permettent d'utiliser des informations relatives à la connectivité des différents éléments qui composent un jeu de données réseau
  • des outils de géotraitement qui vous permettent de prétraiter les entrées, de partager les résultats de vos analyses ou d'utiliser des jeux de données réseau
  • des fonctions et classes d'aide que vous pouvez utiliser pour travailler avec certains types de données utilisées par les classes qui vous permettent d'effectuer des analyses de réseau

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.

Le module de partage vous permet de créer un brouillon de partage à partir d'une carte dans un projet ArcGIS Pro, lequel peut ensuite être partagé sur ArcGIS Enterprise, ArcGIS Online, or ArcGIS Server. Un brouillon de partage est un ensemble de propriétés configurables pour une couche Web. La création d'un brouillon de partage est la première étape pour automatiser la publication d'une carte, couche, table, ou listes de couches et de tables dans une couche Web à l'aide de Python. Le brouillon de partage peut ensuite être enregistré en tant que fichier de brouillon de définition de service (.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

Remarque :

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.