Skip to main content

Python 3 library to write CZML

Project description

czml3

pypi conda Python codecov pypi-downloads conda-downloads workflow-status Documentation Status

From the official CZML Guide:

CZML is a JSON format for describing a time-dynamic graphical scene, primarily for display in a web browser running Cesium. It describes lines, points, billboards, models, and other graphical primitives, and specifies how they change with time.

czml3 aims to make the process of writing CZML files in Python easy by:

  • Type checking properties
  • Cooercion of data to their required format
  • Forbidding unrecognised properties
  • Creating minimal CZML files
  • Performant JSON serialisation

Insallation

You can install czml3 using pip:

pip install czml3

or conda:

conda install czml3 --channel conda-forge

Examples

A CZML document is a list of packets, which have several properties. Recreating the blue box from Cesium sandcastle's CZML Box:

from czml3 import CZML_VERSION, Document, Packet
from czml3.properties import (
    Box,
    BoxDimensions,
    Color,
    Material,
    Position,
    SolidColorMaterial,
)
from czml3.types import Cartesian3Value
packet_box = Packet(
    id="my_id",
    position=Position(cartographicDegrees=[-114.0, 40.0, 300000.0]),
    box=Box(
        dimensions=BoxDimensions(
            cartesian=Cartesian3Value(values=[400000.0, 300000.0, 500000.0])
        ),
        material=Material(
            solidColor=SolidColorMaterial(color=Color(rgba=[0, 0, 255, 255]))
        ),
    ),
)
doc = Document(
    packets=[Packet(id="document", name="box", version=CZML_VERSION), packet_box]
)
print(doc)
[
    {
        "id": "document",
        "name": "box",
        "version": "1.0"
    },
    {
        "id": "my_id",
        "position": {
            "cartographicDegrees": [
                -114.0,
                40.0,
                300000.0
            ]
        },
        "box": {
            "dimensions": {
                "cartesian": [
                    400000.0,
                    300000.0,
                    500000.0
                ]
            },
            "material": {
                "solidColor": {
                    "color": {
                        "rgba": [
                            0.0,
                            0.0,
                            255.0,
                            255.0
                        ]
                    }
                }
            }
        }
    }
]

czml3 uses pydantic for all classes. As such czml3 is able to coerce data to their right type. For example, the following creates a Position property of doubles using a numpy array of interger type:

import numpy as np
from czml3.properties import Position
print(Position(cartographicDegrees=np.array([-114, 40, 300000], dtype=int)))
{
    "cartographicDegrees": [
        -114.0,
        40.0,
        300000.0
    ]
}

Contributing

You want to contribute? Awesome! There are lots of CZML properties and validations that we still did not implement, which can be found here.

All ideas welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

czml3-2.3.4.tar.gz (116.6 kB view details)

Uploaded Source

Built Distribution

czml3-2.3.4-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file czml3-2.3.4.tar.gz.

File metadata

  • Download URL: czml3-2.3.4.tar.gz
  • Upload date:
  • Size: 116.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for czml3-2.3.4.tar.gz
Algorithm Hash digest
SHA256 5581fcae835db1818eed9cbbbf9bb1662d63b9b8a2618659f0c510eb80d701b0
MD5 9411e5e9c424579f4e18904843e273a0
BLAKE2b-256 2deff3950fe0a2b9733e255e692794fc580358e1dfa79eb623886c5f7c5b5431

See more details on using hashes here.

Provenance

The following attestation bundles were made for czml3-2.3.4.tar.gz:

Publisher: publish-to-pypi.yml on Stoops-ML/czml3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file czml3-2.3.4-py3-none-any.whl.

File metadata

  • Download URL: czml3-2.3.4-py3-none-any.whl
  • Upload date:
  • Size: 27.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for czml3-2.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 41086eba0f5eb65477dcb1847d2b05971e1633bc01e3e76bf4210077608533a9
MD5 7085fd07096d6af4e7985c88286aa679
BLAKE2b-256 3e695d8bd2bf2ef51ed5c5026443e505184b1f5f7897e589daa06536f13d5044

See more details on using hashes here.

Provenance

The following attestation bundles were made for czml3-2.3.4-py3-none-any.whl:

Publisher: publish-to-pypi.yml on Stoops-ML/czml3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page