Add deprecation warnings for features that will disappear with NEST 3. #552
Labels
I: User Interface
Users may need to change their code due to changes in function calls
S: Critical
Needs to be addressed immediately
T: Maintenance
Work to keep up the quality of the code and documentation.
ZC: Kernel
DO NOT USE THIS LABEL
ZP: PR Created
DO NOT USE THIS LABEL
Milestone
NEST 2.12 should issue deprecation warnings for any functions or models that will not be part of NEST 3 and suggest alternatives. Warnings are limited to PyNEST, since few people write SLI these days except for tests.
The critical change in NEST 3 is that subnets will disappear and thus all functions based on subnets. For more on
GIDCollection
s, see #455. Below is a list of model and functions that I suggest to be deprecated.Models
subnet
: work withGIDCollection
s insteadaeif_cond_alpha_RK5
: we need to converge on one implementation for this modelPyNEST functions
BeginSubnet
: no longer needed, work withGIDCollection
sEndSubnet
: no longer needed, work withGIDCollection
sCurrentSubnet
: irrelevant without subnetsGetChildren
: irrelevant without subnets, work withGIDCollection
sGetLID
: LIDs disappear with subnets; used index intoGIDCollection
GetLeaves
: elements ofGIDCollection
s are leavesGetNetwork
: irrelevant without subnets, script is responsible for retaining structure information if neededGetNodes
: you have them inGIDCollection
sLayoutNetwork
: useCreate(<model>, n=<number>)
and get aGIDCollection
DataConnect
: useConnect()
withone_to_one
rule.Notes
PrintNetwork
in its current form depends on subnets. I suggest we let it print information fromModelRangeManager
instead, i.e., list showing GID ranges and pertaining models.The text was updated successfully, but these errors were encountered: