entry point names do not follow convention

[ltalirz]

hey, just letting you know that the entry point naming does not follow AiiDA conventions:

aiida-fireworks-scheduler/setup.json

Lines 17 to 22 in cf70259

	"aiida.schedulers": [
	"fireworks = aiida_fireworks_scheduler.fwscheduler:FwScheduler"
	],
	"aiida.cmdline.data": [
	"fireworks-scheduler = aiida_fireworks_scheduler.cmdline:fw_cli"
	],

The canonical entry point prefix would be fireworks_scheduler

[ltalirz]

P.S. Specifying an compatible version range of aiida-core may also be useful.

[zhubonan]

@ltalirz to double check - you meant the entry point for aiida.cmdline.data?

[ltalirz]

both of them - please use fireworks_scheduler (or fireworks_scheduler.abc)

[zhubonan]

But the AiiDA built in names for schedulers don't have the suffix '_scheduler' (e.g. she, PBS)?

Also, changing this would break backward compatibility - name of the scheduler is stored in the Computer node which are immutable.

[ltalirz]

Thanks, aiida-core was indeed an exception to the convention so far and we've been thinking about whether to enforce it or not.
Will let you know what comes out of the discussion later today.

P.S. Breaking backwards compatibility would indeed not be ideal. However, one could at least add a new entry point that follows the convention and points to the same thing.

[ltalirz]

the decision was made to help clarify the namespacing by adding a core. prefix for entry point names from aiida-core aiidateam/aiida-core#5073 (comment)

the actual change will be made at some point in the future, but with 2.0 we will add deprecation warnings for entry point without the prefix.
of course, in aiida-core we have the ability to migrate entry point names; migration of nodes in plugins is still an unsolved problem.

for your plugin I would suggest to keep the fireworks entry point name for backwards compatibility but eventually (with the 2.0 update) introduce a properly namespaced entry point name that points to the same thing.

[zhubonan]

OK, thanks for letting me know! For the cmdline entry point I will change the name as it does not have any problem.

This to confirm - following the convention:

aiida-fireworks-scheduler/setup.json

Lines 17 to 22 in cf70259

	"aiida.schedulers": [
	"fireworks = aiida_fireworks_scheduler.fwscheduler:FwScheduler"
	],
	"aiida.cmdline.data": [
	"fireworks-scheduler = aiida_fireworks_scheduler.cmdline:fw_cli"
	],

should be:

 "aiida.schedulers": [ 
     "fireworks_scheduler.fireworks = aiida_fireworks_scheduler.fwscheduler:FwScheduler" 
 ], 
 "aiida.cmdline.data": [ 
     "fireworks_scheduler.cmd = aiida_fireworks_scheduler.cmdline:fw_cli"  
 ], 

?

I will change the entry point name for aiida.cmdline.data, as there is no issue with backward compatibility.

[ltalirz]

Yes, for example.

We still need to decide whether we also allow fireworks_scheduler as an entry point for cases like these where you are only adding one entry point per group. Anyhow, using fireworks_scheduler.abc as you do here is safer in case you ever want your plugin to add more than one entry point to a given group

As mentioned, you can keep the old entry point name for the scheduler around for backwards compatibility if you like

[zhubonan]

@ltalirz Thanks, I have decided to go with:

        "aiida.schedulers": [
            "fireworks = aiida_fireworks_scheduler.fwscheduler:FwScheduler",
            "fireworks_scheduler.default = aiida_fireworks_scheduler.fwscheduler:FwScheduler",
            "fireworks_scheduler.keepenv = aiida_fireworks_scheduler.fwscheduler:FwSchedulerKeepEnv"
        ],

Having the prefix is very useful, it turns out there needs to be two ways of launching aiida jobs when task farming, depending on what type of real scheduler is used.