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.

Sign up for GitHub

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

Jump to bottom

Organize installed examples and documentation. #291

Open
1 of 3 tasks
tammoippen opened this issue Apr 5, 2016 · 6 comments
Open
1 of 3 tasks

Organize installed examples and documentation. #291

tammoippen opened this issue Apr 5, 2016 · 6 comments
Assignees
@jougs @jessica-mitchell
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Discussion Still searching for the right way to proceed / suggestions welcome

Comments

@tammoippen
Copy link
Contributor

tammoippen commented Apr 5, 2016 •
edited by jougs
Loading

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
  • put the testsuite related code into a separate subdirectory, e.g. into <installdir>/share/doc/nest/testsuite or into <installdir>/share/nest/extras/testsuite
  • replace the 'one folder / one file' system with one file only with a meaningful name.
@tammoippen tammoippen mentioned this issue Apr 11, 2016
Closed
@heplesser heplesser added ZC: Documentation 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: Pending 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 Nov 17, 2016
@jougs
Copy link
Contributor

jougs commented Feb 7, 2018

@steffengraber, @terhorstd, @jessica-mitchell

@terhorstd terhorstd added ZC: Installation DO NOT USE THIS LABEL and removed ZC: Documentation DO NOT USE THIS LABEL labels Sep 13, 2018
@jougs jougs mentioned this issue Apr 16, 2019
Closed
4 tasks
@jougs jougs assigned clinssen and unassigned jougs Apr 16, 2019
@heplesser heplesser added this to the NEST 3.0 milestone Jan 10, 2020
@heplesser
Copy link
Contributor

See also #1382

@heplesser heplesser removed ZC: Installation DO NOT USE THIS LABEL ZP: Pending DO NOT USE THIS LABEL labels Apr 7, 2020
@terhorstd terhorstd mentioned this issue Jun 16, 2020
Merged
@terhorstd terhorstd added T: Discussion Still searching for the right way to proceed / suggestions welcome and removed T: Maintenance Work to keep up the quality of the code and documentation. labels Jun 23, 2020
@clinssen clinssen mentioned this issue Jul 2, 2020
Merged
@terhorstd terhorstd mentioned this issue Jul 31, 2020
Closed
@stinebuu stinebuu assigned jougs and unassigned steffengraber and sarakonradi Oct 23, 2020
@sarakonradi sarakonradi removed this from the NEST 3.0 milestone Feb 1, 2021
@jougs jougs mentioned this issue Feb 2, 2021
Closed
@terhorstd terhorstd mentioned this issue Feb 12, 2021
Closed
@heplesser
Copy link
Contributor

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

@github-actions
Copy link

Issue automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Sep 14, 2021
@clinssen
Copy link
Contributor

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

@jougs
Copy link
Contributor

jougs commented Nov 25, 2022

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

@jessica-mitchell jessica-mitchell moved this to To do in PyNEST-NG Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jougs jougs

@jessica-mitchell jessica-mitchell

Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Discussion Still searching for the right way to proceed / suggestions welcome
Projects
PyNEST-NG
Status: To do
Milestone
No milestone
Development

No branches or pull requests
9 participants
@heplesser @steffengraber @jougs @jessica-mitchell @tammoippen @terhorstd @stinebuu @clinssen @sarakonradi