mdanalysis icon indicating copy to clipboard operation
mdanalysis copied to clipboard

Change name of `asel` in timeseries to something more comprehensible.

Open hmacdope opened this issue 3 years ago • 12 comments
trafficstars

    I know we're just doing the same as what memoryreader does, but it just struck me that `asel` is such a weird parameter name for an atomgroup. Not much we can do here, but if I'm not the only one maybe we can consider changing this for 3.0 (in a different PR, let's get this merged!).

Originally posted by @IAlibay in https://github.com/MDAnalysis/mdanalysis/pull/3890#discussion_r1014879026

I agree with @IAlibay that the name asel is a little confusing and could do with a change in 3.0. leave your opinions below.

Will require a deprecation warning first if we go ahead.

hmacdope avatar Nov 06 '22 22:11 hmacdope

yes, please, ~~asel ▶️ selection ?~~ EDIT: atomgroup (see below)

orbeckst avatar Nov 11 '22 22:11 orbeckst

yes, please, asel ▶️ selection ?

asel is an atomgroup right? atomgroup might be closer to what we do elsewhere?

IAlibay avatar Nov 11 '22 22:11 IAlibay

yeah, you're right

orbeckst avatar Nov 11 '22 22:11 orbeckst

@MDAnalysis/gsoc-mentors making this a gsoc-starter issue

hmacdope avatar Feb 14 '23 09:02 hmacdope

@hmacdope isn't this a 3.0 targeted change? We wouldn't be able to merge it during the application period.

IAlibay avatar Feb 14 '23 10:02 IAlibay

Ah yes sorry I meant the deprecation warning part. Do we think that is suitable ?

hmacdope avatar Feb 14 '23 10:02 hmacdope

Ah yes sorry I meant the deprecation warning part. Do we think that is suitable ?

Sounds good to me!

IAlibay avatar Feb 14 '23 10:02 IAlibay

hi @hmacdope, I want to work on MDAnalysis as part of GSoC and wanted to take up this issue. Seems like it won't get merged during the application period. However, can I work on it?

tushdemort avatar Mar 09 '23 12:03 tushdemort

Please go ahead and make a PR! If you make a fix it can be merged in the application period.

hmacdope avatar Mar 09 '23 17:03 hmacdope

Hi @hmacdope

I have made changes for asel in timeseries wherever the function is defined and called. I have also made changes in the test code for the same. Do you think sample_atom_group is a good variable name in place of asel (can be a little wordy)? atom_group and atomgroup are used as variable/function names in a couple of files.

Also, I didn't understand the discussion regarding the deprecation warning, can you explain it a bit?

tushdemort avatar Mar 11 '23 12:03 tushdemort

@hmacdope I'm reopening to keep an issue to track the removal of asel - please do reclose if there's another one already.

IAlibay avatar Dec 03 '23 09:12 IAlibay

Cheers, nah this is it.

hmacdope avatar Dec 03 '23 10:12 hmacdope