Organize installed examples and documentation.

[tammoippen]

The directory <installdir>/share/doc/nest and <installdir>/share/nest after install is quite unorganized and crowded:

• All testsuite related code is distributed at its toplevel. Also, the directory <installdir>/share/nest/extras contains the do_test.py/sh files for running the tests, which seems to be an unnecessary separation.
• Examples mixed inside the examples subdirectory and in other install locations (follow up to trac.654):
  • most are located in <installdir>/share/doc/nest/examples , with NEST/SLI examples in the top dir, and paper and topic related examples are in subdirectories.
  • some ConnPlotter examples are located in <installdir>/lib/pythonX.Y/site-packages/ConnPlotter/examples
• Some documentation comes in a one folder / one file manner. This does not add to an easier orientation in the documentation:
  • bibliography/nest.bib
  • conngen/conngen.txt
  • ConnPlotter/connplotter_tutorial.pdf

I propose to:

• [ ] organize the examples into a coherent structure, e.g.
  • <installdir>/share/nest/examples/
    • NEST/SLI
    • PyNEST
    • MUSIC
    • CSA
    • PyCSA
    • ConnPlotter
    • examples from papers
• [x] put the testsuite related code into a separate subdirectory, e.g. into <installdir>/share/doc/nest/testsuite or into <installdir>/share/nest/extras/testsuite
  • fixed by #2108
• [ ] replace the 'one folder / one file' system with one file only with a meaningful name.

[jougs]

@steffengraber, @terhorstd, @jessica-mitchell

[heplesser]

See also #1382

[heplesser]

@jessica-mitchell Could you take a look and come up with a suggestion?

[github-actions[bot]]

Issue automatically marked stale!

[clinssen]

I would suggest to close this, as many of @tammoippen's points have already been addressed elsewhere in the mean time.

[jougs]

This will become much easier once SLI is not around anymore. I have thus moved it to the corresponding project.