datamodel’s documentation

This is the documentation for the SDSS Python product datamodel. The current version is 0.6.1dev. You can install the package by doing

$ git clone https://github.com/sdss/datamodel
$ cd datamodel
$ pip install -e .

The above pip command installs a lightweight package for using the Python datamodel representations only, see Navigating Datamodels. For generating or designing new datamodels, you need to install extra dependencies with the gen extras options, i.e.

$ pip install -e ".[gen]"

This will install all dependencies needed for generating datamodels, with support for FITS files only. Support for additional file types requires extra dependency packages to be installed.

Supported Files

Filetype	Suffix	Package	Install Command
FITS	.fits	astropy	N/A
Yanny files	.par	pydl	“.[gen, par]”
HDF5 files	.h5	h5py	“.[gen, hdf]”

To install all extra file dependencies, run pip install -e ".[all]" during the installation process.

The sdss datamodel product is a python package for creating, validating, and navigating datamodels for SDSS data products.

Content

• Generating Datamodels
  • Supported Filetypes
  • Generating a datamodel
  • A Note on Releases
  • The YAML structure
  • Validating datamodels
  • Adding new releases
  • Recommended Science Product
  • Generating a datamodel by file
  • Adding the datamodel to the DSI
  • Changing the Markdown Release Example
  • Yanny Parameter files
  • HDF5 Files
• Navigating Datamodels
  • The SDSS Datamodel
  • Data Products
  • Reorganizing
  • Data Levels
  • Metadata Models
• Designing Datamodels
  • Creating the Design Stub
  • Designing an HDU
  • Designing a Par File
  • Designing a HDF5 File
  • Creating a New File
• Manipulating Datamodels
  • Removing Releases

Examples

• Generate
• Design
  • Converting a CSV File

Reference

• datamodel Reference
• Change Log
• Command-line Interface
• Adding New Files