hdf5-reader-service

Microservice for reading HDF5 data and serving it via REST, aimed at performance and concurrency

PyPI	pip install hdf5-reader-service
Source code	https://github.com/DiamondLightSource/python-hdf5-reader-service
Documentation	https://DiamondLightSource.github.io/hdf5-reader-service
Releases	https://github.com/DiamondLightSource/python-hdf5-reader-service/releases

To run a basic server:

hdf5-reader-service --host <host> --port <port>

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

Tutorials

• Installation
  • Check your version of python
  • Create a virtual environment
  • Installing the library

How-to Guides

Practical step-by-step guides for the more experienced user.

How-to Guides

• How to accomplish a task

Explanations

Explanation of how the library works and why it works that way.

Explanations

• Why is something the way it is

Reference

Practical step-by-step guides for the more experienced user.

Reference

• API
• Contributing
  • Running the tests
  • Code Styling
  • Documentation
  • Release Process
  • Updating the tools
• Releases
• Index

About the documentation

Why is the documentation structured this way?