A Python API for the Full-Metadata Format

The Full-Metadata Format (FMF) is described in http://arxiv.org/abs/0904.1299. This repository contains the description and implementation of a python API for the FMF.

License

Copyright (c) 2014 - 2017, Rectorate of the University of Freiburg All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the Freiburg Materials Research Center, University of Freiburg nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Contents

• ./README.md -- this file
• ./API -- API definition
• ./pyfmflib/tests/ -- tests implementing the API
• ./pyfmflib/ -- the pyfmflib package
• ./streamlib_ansatz -- skeleton of a different ansatz of implementation

Tests

The acceptance tests are based on py.test. After installing pyfmflib run them with

py.test pyfmflib/tests/

Status

The API has converged but is still open for minor changes that might become necessary during the implementation.

The pyfmflib package

pyfmflib is the python package that implements the compliance level 1 API.

Later implementations of further compliance levels might follow.

Status

The package is currently being developed.