Time Atlas Python Documentation

Welcome to the Time Atlas Python client library documentation!

Time Atlas is a comprehensive platform for managing and analyzing historical geospatial data. This Python client provides a convenient interface for accessing TimeAtlas API endpoints and working with Research Data Entities (RDEs).

Contents:

• Getting Started
  • Installation
  • Prerequisites
  • Basic Usage
  • Next Steps
  • Troubleshooting
• Data Model
  • Overview
• Research Data Entities
  • 1. Historical Record (HR)
  • 2. Observation (Obs)
  • 3. Point of Interest (PoI)
  • 4. Geometry
  • 5. Dataset
  • 6. Map
  • 7. Layer
  • 8. Area
• Configuration and Supporting Entities
  • Multilingual Values
  • Free-Form Metadata Fields
  • Dataset Configuration
  • Layer Configuration
  • Geographical Extent
  • Time Ranges
  • Height Information
• Working with the Data Model
  • Type Aliases
  • Serialization
  • Creating from DataFrames
• Summary
• API Reference
  • RDE Model
  • TimeAtlas Client
  • Enumerations
  • Core Modules
• Examples
  • Working with Historical Records
  • Working with Observations
  • Working with Datasets
  • Working with Maps and Layers
  • Working with Geospatial Data
  • Client Usage Patterns

Quick Links

• Getting Started - Installation and basic usage

• Data Model - Understanding the RDE data model

• API Reference - Complete API reference

• Examples - Usage examples and recipes

Overview

The Time Atlas Python library provides:

• Time Atlas RDE data model: Accurately represents the Research Data Entity types (Historical Records, Observations, Points of Interest, Geometries, Datasets, Maps, Layers, and Areas)

• Type Safety: Comprehensive type hints and dataclass-based models for all RDEs

Installation

Install the package via pip:

pip install time-atlas-python

Quick Start

from timeatlas import TimeAtlas

# Initialize the client
client = TimeAtlas(api_url='https://your-timeatlas-instance.com/v1')

# Fetch a single RDE object
entity = client.get_single_rde_object('historical-records', 'uuid-here')

Requirements

• Python 3.12 or higher

• requests >= 2.31.0

• pandas >= 2.0.0

• shapely >= 2.0.0