Timepix experiment documentation - Experiment set-up

scipp / essimaging

Imaging data reduction for the European Spallation Source

BSD 3-Clause "New" or "Revised" License

0 stars 1 forks source link

Timepix experiment documentation - Experiment set-up #27

Open YooSunYoung opened 3 weeks ago

YooSunYoung commented 3 weeks ago

I think it's relevant to this repository since it can show the connection of the workflows with the specific steps of the experiment.

There is no duplicating information anywhere since it was never documented/published other than individual log-book : D...

This PR mostly contains experiment set-up. I'll add materials for the measurements later.

jl-wynen commented 3 weeks ago

I don't see what this has to do with data reduction. Other instruments also need to align and adjust their detectors. But that is done by the instrument teams, not us. Can you clarify which parts of this PR actually pertain to data reduction?

YooSunYoung commented 3 weeks ago

I don't see what this has to do with data reduction. Other instruments also need to align and adjust their detectors. But that is done by the instrument teams, not us. Can you clarify which parts of this PR actually pertain to data reduction?

Yeah I agree. As I said in the stand-up it's more for providing context both for developers and scientists. That's why it's in the About page. For example,

experimental settings for developers, like what kind of parameters should be included in the workflow.
what kind of computational methods are available for specific steps of the experiment for the scientists.

Even if they are all standard procedures for other instruments as well, this page might help to reduce some gaps of using different terminology in specific fields ...? : D...

nvaytet commented 3 weeks ago

I think if you want to keep that information somewhere which is not a confluence page, then we need to think of maybe a different repo or something. I agree with @jl-wynen that this is not really the right place for it. It reads more like a log for an experiment.

YooSunYoung commented 3 weeks ago

It reads more like a log for an experiment.

It is a log for an specific experiment, but Søren said it's very general set-up of timepix neutron imaging experiment.

I think if you want to keep that information somewhere which is not a confluence page, then we need to think of maybe a different repo or something.

I also thought about it but I think it's not a bad idea to have some background knowledge in this repo. More importantly I couldn't think of a better place. It's better misplacing this somewhere accessible than losing it somewhere in the confluence...

YooSunYoung commented 3 weeks ago

I think we don't have to be super-careful about documenting high-level background knowledge. It's not as dangerous as adding an experimental feature in the package.