Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.27 KB

README.md

File metadata and controls

37 lines (29 loc) · 1.27 KB
Raw

ceos-ard-spec-tables

Companion to S1_NRB in order to more efficiently handle CEOS-ARD specification metadata tables. Note that this repository is still work in progress.

Installation

conda

conda env create -f https://raw.githubusercontent.com/maawoo/ceos-ard-spec-tables/main/environment.yml
conda activate cast_env
pip install git+https://github.com/maawoo/ceos-ard-spec-tables.git

Usage

Load Excel file into a CASTMeta object

from pathlib import Path
from cast.load import CASTMeta

file_dir = Path("./assets")
nrb_55 = CASTMeta(file_path=file_dir.joinpath("nrb", "CARD4L_METADATA-spec_NRB-v5.5.xlsx"))

# A dictionary of pandas DataFrames containing the cleaned up tables of the original Excel file is available
# as the attribute `data` of the CASTMeta object. The dictionary keys correspond to the sheet names.
nrb_55.data

Create reports by comparing different objects

import cast.compare as compare

# Compare CASTMeta objects: Different versions of the same specification
compare_nrb = compare.by_item_names(cast_1=nrb_50, cast_2=nrb_55)

# Compare CASTMeta objects: Different specifications
compare_nrb_orb = compare.by_item_names(cast_1=nrb_55, cast_2=orb_10)