Python PDS4 Tools

Introduction

PDS4 Python Tools is pure-Python module that can read and display PDS4 data and meta data. This tool supports all common PDS4 data structures as listed in the Supported Data Structures section. The package expects valid PDS4 labels formatted according to the PDS4 Standard.

An PDS4 reader and visualizer for IDL is separately available.

Contact Lev Nagdimunov with questions or comments regarding this tool, or report issues on GitHub.

Installation

PDS4 Python Tools is a pure-Python package available in PyPi and CondaForge.

Install an official release

To install the package via pip, run this command:

python -m pip install -U pds4_tools

To install the package via conda, run this command:

conda install -c conda-forge pds4_tools

Install from source

You may also install the latest development version from GitHub:

git clone https://github.com/Small-Bodies-Node/pds4_tools.git
cd pds4_tools
python -m pip install .

Download

Download the development source code from GitHub.
Download the latest official release: PDS4 tools-1.3.zip. Released on October 10, 2021.

Note: A distributable version of the viewer only, which does not require Python, is available.

Requirements

Python 2.7 or 3.5+

pds4_read: NumPy
pds4_viewer: NumPy, matplotlib

User Manual

Online usage documentation, both for scientists and for developers, is available.

Supported Data Structures

PDS4 Data Standards >= v1.0 are supported.
PDS3 Data Standards are not supported.

The table below lists the main PDS4 data structures and the current status.

Structure

Read-in

Display as Table

Display as Image

Display Columns as Plot

Header

Yes

No

No

No

Array

Yes

Yes

Yes, N-dims

Yes, 1-D only

Array_2D

Yes

Yes

Yes

No

Array_2D_*

Yes

Yes

Yes

No

Array_3D

Yes

Yes

Yes

No

Array_3D_*

Yes

Yes

Yes

No

Table_Character

Yes

Yes

No

Yes

Table_Binary

Yes, except BitFields

Yes

No

Yes

Table_Delimited

Yes

Yes

No

Yes

Composite_Structure

No

No

No

No