Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecation warnings for features that will disappear with NEST 3. #552

Closed
heplesser opened this issue Nov 21, 2016 · 3 comments · Fixed by #580
Closed

Add deprecation warnings for features that will disappear with NEST 3. #552

heplesser opened this issue Nov 21, 2016 · 3 comments · Fixed by #580
Assignees
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

Comments

@heplesser
Copy link
Contributor

heplesser commented Nov 21, 2016

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 GIDCollections, see #455. Below is a list of model and functions that I suggest to be deprecated.

Models

  • subnet: work with GIDCollections instead
  • aeif_cond_alpha_RK5: we need to converge on one implementation for this model

PyNEST functions

  • BeginSubnet: no longer needed, work with GIDCollections
  • EndSubnet: no longer needed, work with GIDCollections
  • CurrentSubnet: irrelevant without subnets
  • GetChildren: irrelevant without subnets, work with GIDCollections
  • GetLID: LIDs disappear with subnets; used index into GIDCollection
  • GetLeaves: elements of GIDCollections are leaves
  • GetNetwork: irrelevant without subnets, script is responsible for retaining structure information if needed
  • GetNodes: you have them in GIDCollections
  • LayoutNetwork: use Create(<model>, n=<number>) and get a GIDCollection
  • DataConnect: use Connect() with one_to_one rule.

Notes

  • PrintNetwork in its current form depends on subnets. I suggest we let it print information from ModelRangeManager instead, i.e., list showing GID ranges and pertaining models.
@heplesser heplesser added ZC: Kernel DO NOT USE THIS LABEL I: User Interface Users may need to change their code due to changes in function calls ZP: Pending DO NOT USE THIS LABEL S: Critical Needs to be addressed immediately T: Maintenance Work to keep up the quality of the code and documentation. labels Nov 21, 2016
@heplesser heplesser added this to the NEST 2.12 milestone Nov 21, 2016
@heplesser heplesser self-assigned this Nov 21, 2016
@Silmathoron
Copy link
Member

@heplesser preparing the PR for the correct t_ref implementation in the AEIF models, I just remembered that aeif_cond_alpha_multisynapse is also based on aeif_cond_alpha_RK5... shall we switch it to GSL?

@heplesser
Copy link
Contributor Author

@Silmathoron Would you have time to do this this week?

@Silmathoron
Copy link
Member

Maybe... but I've got the NESTML workshop so probably more like this week-end

@heplesser heplesser added ZP: PR Created DO NOT USE THIS LABEL and removed ZP: Pending DO NOT USE THIS LABEL labels Dec 9, 2016
@jougs jougs closed this as completed in #580 Jan 4, 2017
jougs added a commit that referenced this issue Jan 4, 2017
Deprecation warnings for features that will disappear in NEST 3.0 (fixes #552)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants