search

tjlane / pypad

Intuitive, high-level interface to the CSPAD
Other
2 stars 1 forks source link

document API, CLI, conventions, philosophy #44

Open tjlane opened 11 years ago

tjlane commented 11 years ago

@sellberg I envision a short (5 pg?) TeX document in the pypad repo that explains:

(0) A paragraph about what problem we set out to solve with pypad, and the future we envision for it (1) The CXI convention (2) The layout of the CSPAD and how memory is mapped onto the geometry (3) The basis vector convention used in pypad (4) Unit conventions (4.1) Any other conventions? (5) A brief description of each script

If we plan out what to include here, I can put this together.

tjlane commented 11 years ago

PS. Do you know if anything we've done here is applicable to XPP? I know they have a fixed quad geometry, but they must have the same masking/visualization/etc issues we face.

sellberg commented 11 years ago

@tjlane sounds like a good idea, I think your plan for the document looks really good so we can discuss the details tomorrow. I'm guessing the masking should be applicable, maybe even the geometry if one can use the XPP-geometry as input format and wants to do very fine adjustments, but that probably is not so useful. I talked to Mike Minitti yesterday though and will get access to some XPP data so I'll try it out then and will raise any issues for things not working ;-)