Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 2.37 KB

README.md

File metadata and controls

41 lines (27 loc) · 2.37 KB
Raw

ucvm_metadata_utilities

This repo contains scripts for working with ucvm metadata files. UCVM plotting routines, query UCVM and output PNG files produced using matplotlib. UCVM plotting also outputs the data, and metadata files used to created the PNG files. These utilities scripts are useful for users that want to use the data shown in the PNG plots created by UCVM plotting routintes.

Introduction

UCVM metadata files are produced by the UCVM website. They are also produced by the UCVM plotting routines. Three types of UCVM plotting queries are currently supported including vertical profile plots, vertical cross section plots, and horizontal slice plots. The data directories in this repo contain examples of these plots, as png files, and the associated data and metadata files that contain the data used to create the pngs.

Python3

These scripts use Python3. We typically recommend using Anaconda virtual enviroments for working with UCVM plotting.

Core UCVM is a C-language program but uses Python during installation.

The following example shows how users can change between a Python2/Python3 environment.

  • % conda deactivate

  • Run Python2 scripts

  • % conda activate python3

  • Run these ucvm metadata utility scripts

Use Case

These scripts read the UCVM metadata files and convert them to simpler text file formats. Three cases are currently support:

  1. Convert vertical profiles data (json) and metadata (json) files to a CSV file.
  2. Convert a vertical cross section data (binary) and metadata (json) file to a CSV file.
  3. Convert a horizontal slice data (binary) and metadata (json) file to a CSV file.

In both cases, the UCVM Files are converted into panda dataframes and then written out as CSV files.

Example Usage:

The following examples call the conversion scripts and input the example input data files in this repository. These example input data files were produced by running the UCVM_Plotting scripts.

  1. ucvm_profile2csv.py 1ddta/UCVM_1618866062727vertical_matprops.json 1ddata/UCVM_1618866062727vertical_meta.json
  2. ucvm_cross_section2csv.py 2ddata/cross-cvmsi_data.bin 2ddata/cross-cvmsi_meta.json
  3. ucvm_horizontal_slice2csv.py 2ddata/cvms_poisson_map_data.bin 2ddata/cvms_poisson_map_meta.json

Documentation:

Support

Please send questions/issue to software (at) scec.org