Documentation #1359

Provide wiki page on .int.gz reference files

Added by wuttke almost 5 years ago. Updated almost 5 years ago.

Status:ResolvedStart date:01 Mar 2016
Priority:NormalDue date:
Assignee:wuttke% Done:

0%

Category:-
Target version:-

History

#1 Updated by wuttke almost 5 years ago

  • Priority changed from Normal to Urgent

#2 Updated by wuttke almost 5 years ago

  • Tracker changed from Bug to Documentation
  • Subject changed from Branch issue1358-vectors3d: functional test customformfactor fails. And please, provide tutorial how to analyse such failures to Provide wiki page on .int.gz reference files
  • Priority changed from Urgent to High

Add some hints in the BornAgain wiki about the reference files: What format they are, where they are taken from and written to, and which tools we have to inspect them.

#3 Updated by pospelov almost 5 years ago

*.int format is BornAgain internal ASCII format, which contains detector axes definition and 2D intensity map. You can check the content of the file with Linux "less" command, the content is self explanatory. The format was invented mainly to read/write intensity data for functional testing. It is not positioned as "The BornAgain file format" and we do not advertise it to users. If the user need some specific format/data treatment, he retrieves numpy array and do what he wants.

For quick look there are two scripts

Examples/python/utils/plot_intensity_data.py
Examples/python/utils/plot_intensity_data_diff.py

There is no elaborated machinery on top of *.int files. We didn't need it so far. For custom stuff we create dedicated scripts.

There are two user tutorials which are closely related to the subject:

Please have a look and let me know, if more info is required.

Btw, we have to think of "developers forum", as a place to discuss things like this one.

#4 Updated by wuttke almost 5 years ago

  • Assignee set to wuttke
  • Priority changed from High to Normal

Also available in: Atom PDF