Repository files navigation

Current Version:
Last Update:
Anaconda Total Downloads:
PyPI Downloads:

A powerful Python library for spatial analysis, mapping and GIS

ArcGIS API for Python (codenamed Geosaurus) is a Python library for working with maps and geospatial data. It provides simple and efficient tools for sophisticated vector and raster analysis, geocoding, map making, routing and directions, as well as for organizing and managing a GIS with users, groups and information items. In addition to working with your own data, the library enables access to ready to use maps and curated geographic data from Esri and other autorotative sources. It also integrates well with the scientific Python ecosystem and includes rich support for Pandas and Jupyter notebook.

Geosaurus is a comprehensive GIS expressed in Python. A GIS is a container of geographic information with associated:

• Configurable (schema driven) information model for all sorts of geographic datasets and information items
• Features, maps, imagery, raster, observations, visualizations, analytic results, entity data, tabular datasets,…
• Intelligent container of information with data items organized by user, group, with metadata, with ratings/reputation,…
• Functions for working with entire datasets
• Many wonderful things represented as functions against data organized into packages (used to be tools/toolboxes)
• APIs for constructing and drilling into the insides of datasets
• Iterate over features, create new datasets and add data, etc.
• Aka “I/O” libraries and ways to cast GIS data items into Python items (raster to SciPy, etc.)
• Items for understanding and visualizing data – not just data
• Maps & Scenes
• Pythonic mechanism for defining and working with these items

Developers website

See the developer documentation and resources athttps://developers.arcgis.com/python/

If you are an end user, and would like to use the most recent publicly facing API,follow these installation instructions.

If you are an end user, and would like to use daily builds of this API,follow these installation instructions.

If you are a developer, follow these instructions:

• Installpixi
• Clone this repo:git clone https://github.com/ArcGIS/geosaurus.git
• (Optional) Clone geoserpent repo for access toarcgis-mapping module:git clone https://github.com/ArcGIS/geoserpent.git
• Runpixi shell
  • pass-e daily for an environment with the daily build preinstalled
  • pass-e local for an environment with./src preinstalled
• Runjupyter lab to browse a jupyter lab environment

Note: usingpixi is preferred for its built-in tasks and, in particular, for building docs

• Install Anaconda for Python 3.X fromhttps://www.continuum.io/downloads
• Download or clone this repo.git clone https://github.com/ArcGIS/geosaurus.git
• conda env create --file environment.yml
• Windows:activate geosaurus_dev_env
• Linux/OSX:source activate geosaurus_dev_env
• pip install -e ./src --no-deps (for using latest source code)
• jupyter notebook (to start a jupyter notebook server)

pixi run docs:html builds the html documentation for preview.pixi run docs:preview builds the json documentation and launches the Gatsby preview locally.

Seepixi task ls for additional commands.

The html results will be in./docs/build/html. Open theindex.html file.

• automation
  • This folder contains all of the code run for our legacy C.I. systems
• build
  • This folder contains build.py, the script used to generate all conda packages, or pip packages (deprecated)
  • This folder also contains all the conda config, like build/arcgis/meta.yaml, etc.
• docs
  • This folder contains the script and source for generating our API doc
  • This folder also contains the scripts to convert notebooks to html for the developer's website
• examples
  • Example notebooks
• src
  • This folder contains the pip config (setup.py, setup.cfg, etc.)
  • This folder also contains the actual source code of the API at src/arcgis
  • Note that src/changelog.txt only represents the changelog for pip releases
• unittests
  • This folder contains all of our unit tests, integration tests, etc.

See the wiki athttps://github.com/ArcGIS/geosaurus/wiki for the project vision and guiding principles, areas needing help, and how to contribute.