Synchronize naming scheme of data and abstraction layers

[haesleinhuepf]

We're building similar structures in pyclesperanto (P) and clesperantoj (J). Thus, we should make sure that things have similar names and potentially structure repositories similarily. This was done partly from the very beginning (thanks!) and has potential for sychronizing.

The following listing is from the inside to the outside.

• CLIc: P and J have this in common, it's the C++ core.
• C++ layer code/folder between the CLIC and P/J.
  • P: wrapper
  • J: native
• C++ headers of the wrapper
  • P: pyclesperanto.hpp
  • J: clesperanto.hpp
• Auto-generated code from the native wrapper:
  • P: _pyclic
  • J: clesperantojWrapper
• The "image"/"buffer"/"array" data object representing the image on the GPU
  Naming this is important, because we will see it a billion times future scripts that use clesperanto
  • P: data
  • J: ObjectJ
• The package/module
  This one is tricky. We are limited here by Java/Maven and Python/Pypi conventions. I can only upload to maven-central if the package starts with "net.clesperanto" because I'm owner of the domain. Packages on pypi typically have the same package name as the python module.
  • P: pyclesperanto
  • J: net.clesperanto
• The clesperanto gateway
  • P: Clesperanto
  • J: ClesperantoJ

I would love to hear your optinions @StRigaud and @bnorthan 🙂

[StRigaud]

The "image"/"buffer"/"array" data object representing the image on the GPU
Naming this is important, because we will see it a billion times future scripts that use clesperanto

• P: data
• J: ObjectJ

This one is a tricky thing as, depending on the language, the name may be a keyword or close to it. Ideally we would want something that is common to the three language and that do not create conflict.

The clesperanto gateway

• P: Clesperanto
• J: ClesperantoJ

Not so much important but if all could be Clesperanto ?

For the rest, there is little to no impact to the users. We just have to keep a certain coherence (and maybe a doc?) and we should be fine I would say.

[haesleinhuepf]

Ideally we would want something that is common to the three language and that do not create conflict.

Yes, I'm thinking of something like Image or Array, potentially with a prefix or suffix CL or GPU or ...

[StRigaud]

I am already using a namespace cle hence would avoid any prefix/suffix on CLIc side, an equivalent or a suffix/preffix should be used yes.

The object array already exist in C++, hence Array is maybe too close to it. I am currently rooting for Image 😉 .

I would also avoid the usage of cl as it is already use by opencl core code (namespace cl). And it could bring confusion.

[haesleinhuepf]

"Image" is a great idea actually 🌞
https://github.com/clEsperanto/pyclesperanto_prototype/blob/de6ebd5e456f936b3d4476d2a839c12cc8234927/pyclesperanto_prototype/_tier0/_types.py#L6