DiamondLightSource / httomo

High-throughput tomography pipeline
https://diamondlightsource.github.io/httomo/
Other
5 stars 4 forks source link

Documentation update #282

Closed dkazanc closed 4 months ago

dkazanc commented 5 months ago

Checklist of things to complete the documentation update:

dkazanc commented 5 months ago

Completed Process Lists Guide. @yousefmoazzam could you please have a look, especially the side output part. If anything does not feel right, grammar or technical. thanks

dkazanc commented 4 months ago

@yousefmoazzam I've added a section on how to Interpret Log File. However, as for our discussion block/s VS s/block we probably need to modify it slightly when it becomes clearer?

yousefmoazzam commented 4 months ago

@dkazanc Nice, thanks for the explanations of the logfile contents, that's going to be quite useful to reference to people when the release comes!

Agreed, once we figure out the meaning/reason behind seeing block/s or s/block we should update that section accordingly.