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

Source directory layout reorganisation #1175

Closed
4 tasks
clinssen opened this issue Apr 11, 2019 · 10 comments
Closed
4 tasks

Source directory layout reorganisation #1175

clinssen opened this issue Apr 11, 2019 · 10 comments
Assignees
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) P: Won't fix No one will work on this in the near future. See comments for details S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.

Comments

@clinssen
Copy link
Contributor

clinssen commented Apr 11, 2019

As discussed during the Jülich NEST Hackathon of April 2019.

  • Create a new /src directory and move all C++ and sli source files into here. E.g. /nestkernel, /sli, etc. are moved to /src/nestkernel, /src/sli, etc.
  • PyNEST/SLI/C++ examples should be combined in /examples
  • Create new subdirectories in the /src/models directory according to:
    • stimulating_devices
    • recording_devices
    • spiking_neurons (including precise variants)
    • synapses (maybe we need this also with spiking_, rate_, binary_)
    • binary_neurons
    • rate_neurons
    • gap junctions? dopamine? structural platicity
  • PyNEST test suite should not be part of NEST module
@terhorstd terhorstd added ZC: Infrastructure DO NOT USE THIS LABEL I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) ZP: In progess DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Apr 15, 2019
@jougs
Copy link
Contributor

jougs commented Apr 16, 2019

This is closely related to #291.

@jougs
Copy link
Contributor

jougs commented Apr 16, 2019

In addition to cleaning things up, this also needs to take into account the FHS and commonly respected practice in the major distributions.

@heplesser
Copy link
Contributor

I generally consider this proposal sensible sensible, although I can never decide if I really like the src directory. Most of our examples are also code of a kind. Topology is going to disappear as a separate entity in NEST3.

@clinssen
Copy link
Contributor Author

clinssen commented Jul 5, 2019

Removed topology module from the list.

@hakonsbm hakonsbm added this to the NEST 3.0 milestone Jan 10, 2020
@hakonsbm
Copy link
Contributor

Wait until #1282 is merged!

@jougs jougs removed this from the NEST 3.0 milestone Feb 10, 2020
@heplesser heplesser removed ZC: Infrastructure DO NOT USE THIS LABEL ZP: In progess DO NOT USE THIS LABEL labels Apr 7, 2020
@gtrensch
Copy link
Contributor

@clinssen #1282 is merged.

@gtrensch
Copy link
Contributor

@clinssen Are there any updates on this?

@jougs
Copy link
Contributor

jougs commented Jul 31, 2020

After recent discussions with @terhorstd and others, I am not sure anymore if the first and third point actually have a majority of the developers on their side. We should definitely bring this up again in one of the video conferences. I have a working prototype of the fourth point and the second should also be relatively easy to fix. As I'm working on this already, I'm re-assigning to myself.

@jougs jougs assigned jougs and unassigned clinssen Jul 31, 2020
@jougs
Copy link
Contributor

jougs commented Aug 24, 2020

The fourth point is now described as the solution to #1130.

@jougs jougs added the P: Won't fix No one will work on this in the near future. See comments for details label Aug 24, 2020
@jougs
Copy link
Contributor

jougs commented Aug 24, 2020

As this is more controversial than expected and several points were/are addressed in separate issues, I'm closing this as wontfix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) P: Won't fix No one will work on this in the near future. See comments for details S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Status: Done
Development

No branches or pull requests

6 participants