organisation of files (and usability of PyPI and conda-forge distributions)

[KrisThielemans]

We currently have 4 classes of files

1. the yardl model
2. the generated python/C++ files
3. petsird_helper.* files with some additional functions
4. example code

We anticipate that the "helpers" are going to grow. I personally wouldn't grow the examples too much in this repository, as we have https://github.com/orgs/ETSIhackers/repositories.

Currently, the "helpers" are not available for import after a pip install. It'd be easy enough to do that, but I'm not sure what the best strategy for the location of all these files are.

Suggestions?

[casperdcl]

Separate repo, potentially pip-installable.

[gschramm]

@casperdcl What is the advantage of separating them? I would argue that the helpers are strongly coupled to a specific petsird version, which is why I would include them in the same package.

[casperdcl]

The impression I have from Kris is the examples/demos/helpers are not meant to be closely tied to this repository.

I don't have an opinion either way.

Technically and separate repo/package can easily pin to specific petsird versions.

[gschramm]

I would consider "good and efficient helpers" an essential tool which is why I would prefer to include them.

[KrisThielemans]

It does look like helpers will be necessary on top of the yardl-generated code (sadly), and see no longer see essential reason to separate repos.

As commented by @naegelejd, MRD adds generated files in the repo. I'm still reluctant to do that (but might be wrong).

I see https://github.com/ismrmrd/mrd/tree/main/python/mrd/tools I suppose we could do that as well and move the current examples. Current petsird_helpers.py doesn't really fit in tools I guess. What about

python/
   petsird/
      (generated files will end up here)
      helpers/
           geometry.py # including the rigid transformation stuff
           detection_efficiencies.py

C++ organisation is a bit different, but that'll be for later.

[casperdcl]

Sure, assuming yardl doesn't complain about existing files.

[KrisThielemans]

I checked. it doesn't.