nest-simulator icon indicating copy to clipboard operation
nest-simulator copied to clipboard

Improve docs for guides and getting started

Open jessica-mitchell opened this issue 1 year ago • 1 comments

This PR builds on #3066 focusing on the organization of the guides and tutorials - here the various 'guides' are organized with an initial section for beginners continuing to various topics that would be helpful for the majority of users who are relatively new to NEST. Additional guides are included after. Can only be merged once #3066 is merged

jessica-mitchell avatar Jan 17 '24 11:01 jessica-mitchell

Please check the 'Next steps' section as I tried to put the topics logically together in some cases. I was trying to avoid having too many cards.

@clinssen @ddahmen @heplesser @steffengraber

See output here

Changes made

  • [x] have 3 sections
  • [x] CHANGE next steps: Create you own network model
  • [x] create models --> create neuron, synapse, devices

Move the following to 'next steps'

  • [x] random numbers

  • [x] stimulate the network

  • [x] spatially structured

  • [x] guide to parallel computing

  • [x] remove see also

  • [x] add examples card in next steps

  • [x] large scale models (brunel, microcircuit, meso, mam) NOTE: put large scale models in 'next steps', unsure if that was where we discussed it should go / also not sure about Brunel - I added one example from nest

  • [x] built in timers --> go to hpc

  • [x] nest sonata --> connect to other tools

  • [x] Changed button on index page that links to this page to "start exploring nest" rather than 'get started' since it focuses on the topcis of nest where as 'getting started' kind of implies that it includes installation

  • [x] added new icons

  • [x] remove unused icons

TODO add an example from spatially structured networks to large scale models

jessica-mitchell avatar Feb 29 '24 13:02 jessica-mitchell

@jessica-mitchell Great work! Apart from the typo "how random number" -> "how random numbers" in the "Simulate your network" box, everything looks perfect to me.

ddahmen avatar Mar 07 '24 09:03 ddahmen