NESTival 2019 11

Where: Messstetten, Germany

When: 21.11 - 24.11.2019

(additional work at CodeJam Heidelberg 25.11-28.11.2019)

Participants

• Dennis
• Håkon
• Jessica
• Jochen
• Steffen
• Stine

Changes to code/docs

Pull requests

Merged:

• #1274 Fix pynest api generation for documentation using mock
• #1139 New templates for pynest examples and api
• #1345 Make multimeter and voltmeter class names lower case
• #1262 Add new options for installation and improve instructions for NEST
• #1312 Fix MUSIC example
• #1336 Autogenerate pynest examples from source with sphinx_gallery
• #1340 Fix to allow installation with Python 3.8
• #1342 Replace Python version by newest available on Travis
• #1344 Fix broken css style
• #1346 Update mailing list email address

In progress:

• #1341 @terhorstd

PR/Commits for NEST3 merge

• Updated nest2_vs_nest3 and from_nest2_to_nest3 @stinebuu

• Renamed GIDCollection to NodeCollection @hakonsbm

• Updated tests for modified ascii output file headers @hakonsbm

• Renamed Connectome to SynapseCollection @hakonsbm

• Renamed GID to node ID @hakonsbm

Further developments

• improve cpp documentation @jougs
  • script written to generate nice restructured text with flexibilty to arrange models wit keywords @terhorstd
  • https://github.com/terhorstd/nest-simulator/tree/nest-3-doc-generator
• test installation for nest-3 @steffengraber

• include nestio into guide for nest 3 conversion (wip)
• improve text, and general review of nest 3 docs (wip)

Discusssions

• what all needs to be checked in the documentation before release (wip)

What's next

• Release of NEST 3 - 03.2020

TODO

• go through cii doc related questions
• documentation infrastructure for NEST, NESTML, NEST-Desktop, … [NC - HEIDELBERG?]
  • issue #1317 - missing documentation module > redirect people to NESTML in docs for module creation?
  • N.B. NESTML is migrating all documentation to readthedocs; theme will be consistent with NEST-simulator. Work-in-progress PR: https://github.com/nest/nestml/pull/517
  • visibility of NESTML / NESTDesktop on NEST
• automatic generation of images from pynest/examples
  • how to automatically build images and link them to generated examples
  • organize examples/provide description
• NEST3 related documentation updates
  • remove/update nest3 incompatible documentation (including updating links), see topology
  • ensure both html and pdf build are working
• integrating documentation into release workflow
  • update doc/README.rst
  • running scripts (convert markup to proper links, check links ...)
  • ensure that readthedocs automatically updates master with every merge / likewise for releases
• nest models
  • update models to restructured text
  • remove breathe /doxygen requirements
  • update keywords
• styleguide review, discussion
  • wip here
  • output
• include linting (vale - github action, discussion)
  • example here
• analytics - matomo implementation
• documentation web page layout
  • more visually appealing main page (showcase model types, certain topics, etc)
  • consider EPPO (every page is page one) in structure
  • better integration of nest-simulator website and docs
• reviewing/ editing docs workflow improvement ideas
• glossary of terms for NEST
  • abbreviations/acronyms
  • terms for comp neuroscience
  • one glossary for all docs or separate glossaries for specific topics?