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

Timepix experiment documentation - Experiment set-up #27

Closed
wants to merge 11 commits into from

Conversation

YooSunYoung
Copy link
Member

@YooSunYoung YooSunYoung commented Jun 13, 2024

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.

@YooSunYoung YooSunYoung requested a review from jl-wynen June 13, 2024 06:09
Copy link
Member Author

@YooSunYoung YooSunYoung Jun 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This duck replaces the sample data, since the real sample data needs some reviews.

@YooSunYoung YooSunYoung added the documentation Improvements or additions to documentation label Jun 13, 2024
@jl-wynen
Copy link
Member

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
Copy link
Member Author

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
Copy link
Member

nvaytet commented Jun 13, 2024

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
Copy link
Member Author

YooSunYoung commented Jun 13, 2024

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
Copy link
Member Author

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.

@YooSunYoung
Copy link
Member Author

@YooSunYoung YooSunYoung deleted the timepix-experiment branch February 25, 2025 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants