Metadata-Version: 2.1
Name: sdds
Version: 0.1.1
Summary: Read and write sdds files.
Home-page: https://github.com/pylhc/sdds
Author: pyLHC
Author-email: pylhc@github.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy

# SDDS
[![Travis (.com)](https://img.shields.io/travis/com/pylhc/sdds.svg?style=popout)](https://travis-ci.com/pylhc/sdds/)
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/sdds.svg?style=popout)](https://codeclimate.com/github/pylhc/sdds)
[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/sdds.svg?style=popout)](https://codeclimate.com/github/pylhc/sdds)
[![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/sdds.svg?style=popout)](https://github.com/pylhc/sdds/)
[![GitHub release](https://img.shields.io/github/release/pylhc/sdds.svg?style=popout)](https://github.com/pylhc/sdds/)

This package provides reading and writing functionality for **self describing data sets (sdds)**. 

## Getting Started

### Prerequisites

The only third-party package sdds depends on is `numpy`.


### Installing

Installation is easily done via `pip`. The package is then used as `sdds`.

```
pip install sdds
```

Example:

```
import sdds

sdds_data = sdds.read('path_to_input.sdds')
sdds.write(sdds_data, 'path_to_output.sdds')
```


## Description

Reading and writing capabilities for [sdds-files](https://ops.aps.anl.gov/SDDSIntroTalk/slides.html)
are provided by this package. On the python side, the data is stored in a class structure
with attributes corresponding to the sdds-format itself 
(see [sdds-format](https://ops.aps.anl.gov/manuals/SDDStoolkit/SDDStoolkitsu2.html)).


## Known Issues

- Can't read ASCII files
- Can't read binary columns
- No support for `&include` tag


## Authors

* **Jaime** - *Initial work* - [jaimecp89](https://github.com/jaimecp89)
* **Lukáš** - *Other work* - [lmalina](https://github.com/lmalina)
* **Josch** - *Publishing* - [JoschD](https://github.com/JoschD)
* **pyLHC/OMC-Team** - *Working Group* - [pyLHC](https://github.com/orgs/pylhc/teams/omc-team)


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details



