Open chillenzer opened 7 months ago
Ouch, I thought I was smart when introducing this short-hand :D Yes, colliding with a std module name is not ideal.
Agreed, great idea to come up with a new documented/uniform short-hand. I am not a big fan of pmd
as abbreviation, because there is only openPMD
. I also do not want people to abbreviate openPMD as PMD, to keep the name recognition clear.
Ideas welcome! :)
import openpmd_api as pmd # hm
or
import openpmd_api as oio # lol
or
import openpmd_api as api # too generic
or
import openpmd_api as opmd # okish?
or
import openpmd_api as data
or ...?
The pythonic idiom
Explicit is better than implicit.
could be interpreted as not actually needing a shorthand at all. Given that I'm currently sitting in front of a 4K monitor with an IDE doing autocompletion, I could totally spare the additional 7-8 characters.
That said,
import openpmd_api as opmd # okish?
was what came to my mind, too.
@ax3l, there's a push in PIConGPU to start implementing this. We'd go with opmd
unless there is a consensus here soon.
I think that opmd
is the most obvious solution and you can go forward with it
What do you want to achieve, please describe.
In PIConGPU, I've stumbled across the fact that your documentation suggests to use
which coincidentally is also the name of a standard library module in the Python language.
This is an unfortunate ambiguity. We are in the process of coming up with a different convention for PIConGPU ourselves but if you feel the same about this, we would be inclined to wait for the openPMD community to come up with a less ambiguous convention to adopt. Any thoughts?