Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #13

Draft
wants to merge 19 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added explanation for why this microservice was made
  • Loading branch information
OCopping committed Mar 24, 2022
commit cce99c97b636db10d03c43b13ffee55412d8e45d
1 change: 1 addition & 0 deletions docs/explanations.rst
Original file line number Diff line number Diff line change
@@ -10,3 +10,4 @@ Explanation of how the library works and why it works that way.

explanations/why-is-something-so
explanations/why-multiprocessing
explanations/why-make-hdf5-reader-service
10 changes: 10 additions & 0 deletions docs/explanations/why-make-hdf5-reader-service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Why make the HDF5 Reader Service?
=================================

The HDF5 Reader Service was designed as a replacement to the existing DAWN
Dataserver for the General Data Aquisition (GDA) system at Diamond Light Source.

The DAWN Dataserver for GDA is a fairly old and hard to maintain data-broker
service written in Java. It was decided to try and make a much simpler and
easier-to-maintain microservice in Python, using REST endpoints for querying
instead of hard-coding the logic into GDA.