search

PaNOSC-ViNYL / ViNYL-project

This repository keeps track of tasks, milestones, deliverables of workpackage 5 in panosc.
Apache License 2.0
5 stars 5 forks source link

pyvinyl intermediate API layer #34

Closed CFGrote closed 2 years ago

CFGrote commented 4 years ago

After completing the top level pyvinyl API (BaseCalculator/Parameters), we now have to define the intermediate APIs:

Take the corresponding Calculators in SIMEX as templates. Move as many parameters as possible from the specialized parameter classes into the intermediate level. For each level, ensure the API documentation (autogenerated) is ok and add a usage example as a jupyter notebook.

mads-bertelsen commented 2 years ago

I don't see why an intermediate API layer is needed. If libpyvinyl provides a consistent interface and this is adopted in both SIMEX and McStasScript, we will have harmonised them as we set out to do, and hopefully made maintenance simpler.

What would be gained from this intermediate layer? It looks like a version of simex that just adds neutron scattering, but in a way that is not really compatible with how McStas works.

shervin86 commented 2 years ago

Shall we close this issue?

JunCEEE commented 2 years ago

This seems obsoleted.