Skip to content

Commit 42726aa

Browse files
committed
badges, linting
1 parent 24642c9 commit 42726aa

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
# SDDS
2-
[![Cron Testing](https://github.com/pylhc/sdds/workflows/Cron%20Testing/badge.svg)](https://github.com/pylhc/sdds/actions?query=workflow%3A%22Cron+Testing%22)
3-
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/sdds.svg?style=popout)](https://codeclimate.com/github/pylhc/sdds)
4-
[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/sdds.svg?style=popout)](https://codeclimate.com/github/pylhc/sdds)
5-
<!-- [![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/sdds.svg?style=popout)](https://github.com/pylhc/sdds/) -->
2+
3+
[![Tests](https://github.com/pylhc/sdds/actions/workflows/coverage.yml/badge.svg?branch=master)](https://github.com/pylhc/sdds/actions/workflows/coverage.yml)
4+
[![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/sdds.svg?style=popout)](https://github.com/pylhc/sdds/)
65
[![PyPI Version](https://img.shields.io/pypi/v/sdds?label=PyPI&logo=pypi)](https://pypi.org/project/sdds/)
76
[![GitHub release](https://img.shields.io/github/v/release/pylhc/sdds?logo=github)](https://github.com/pylhc/sdds/)
87
[![Conda-forge Version](https://img.shields.io/conda/vn/conda-forge/sdds?color=orange&logo=anaconda)](https://anaconda.org/conda-forge/sdds)
98
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5705820.svg)](https://doi.org/10.5281/zenodo.5705820)
109

1110
This package provides reading and writing functionality for [**self describing data sets (sdds)**](https://ops.aps.anl.gov/SDDSIntroTalk/slides.html) files.
12-
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)).
11+
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)).
1312

1413
See the [API documentation](https://pylhc.github.io/sdds/) for details.
1514

1615
## Installing
1716

1817
Installation is easily done via `pip`:
18+
1919
```bash
2020
python -m pip install sdds
2121
```
2222

2323
One can also install in a `conda` environment via the `conda-forge` channel with:
24+
2425
```bash
2526
conda install -c conda-forge sdds
2627
```
@@ -40,7 +41,7 @@ By default the endianness (byte order) of the file is determined either by
4041
a comment `!# little-endian` or `!# big-endian` in the header of the file.
4142
If this comment is not found, the endianness of the running machine is assumed.
4243

43-
One can force a certain kind of endianness to the reader by supplying it to
44+
One can force a certain kind of endianness to the reader by supplying it to
4445
the read function:
4546

4647
```python
@@ -50,9 +51,9 @@ sdds_data = sdds.read("path_to_input_with_big_endian.sdds", endianness="big")
5051
sdds_data = sdds.read("path_to_input_with_little_endian.sdds", endianness="little")
5152
```
5253

53-
Be aware that `sdds.write` will always write the file in big-endian order and
54+
Be aware that `sdds.write` will always write the file in big-endian order and
5455
will also leave a comment in the file, so that the reader can determine the
55-
endianness and there is no need to supply it when reading
56+
endianness and there is no need to supply it when reading
5657
a file written by this package.
5758

5859
## Known Issues

0 commit comments

Comments
 (0)