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

Revised content in the "Introduction to PyNEST" #661

Merged
merged 15 commits into from Mar 13, 2017

Conversation

Projects
None yet
5 participants
@steffengraber
Contributor

steffengraber commented Feb 14, 2017

Content update reflecting the status per October 2016.

I suggest @abigailm and @jougs as reviewers.

@Silmathoron

Hit @steffengraber,
in python_interface.png, could you replace "iaf_neuron" by "iaf_psc_alpha", since we're in the process of removing it?

@@ -79,9 +79,14 @@ populations and will also be returned by the function `Models()`.
ipop1 = nest.Create("inh_iaf_neuron", 30)
ipop2 = nest.Create("inh_iaf_neuron", 30)
Once you have set up your populations of neurons, the function `PrintNetwork()`

This comment has been minimized.

@Silmathoron

Silmathoron Feb 15, 2017

Contributor

Why remove the part about PrintNetwork?

@Silmathoron

Silmathoron Feb 15, 2017

Contributor

Why remove the part about PrintNetwork?

This comment has been minimized.

@heplesser

heplesser Feb 16, 2017

Contributor

In this case, users might perceive the output of PrintNetwork() as confusing rather than helpful, since the two populations of 30 neurons each would show up as one range of 60 neurons. With subnet removal in NEST3, PrintNetwork() will become even less useful. So I think we might as well drop it here and rather add new suggestions when we revise documentation for NEST3.

@heplesser

heplesser Feb 16, 2017

Contributor

In this case, users might perceive the output of PrintNetwork() as confusing rather than helpful, since the two populations of 30 neurons each would show up as one range of 60 neurons. With subnet removal in NEST3, PrintNetwork() will become even less useful. So I think we might as well drop it here and rather add new suggestions when we revise documentation for NEST3.

This comment has been minimized.

@abigailm

abigailm Feb 20, 2017

Contributor

I agree with @heplesser

@abigailm

abigailm Feb 20, 2017

Contributor

I agree with @heplesser

Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-3-connecting-networks-with-synapses.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-3-connecting-networks-with-synapses.md Outdated

steffengraber added some commits Feb 16, 2017

some minor changes
changed "neurans" to "neurons"  (line 143)
introducing [Connection management][cm]
better readable
a list for linebreaks (line 303)
make bold for highlighting (line 318)
@steffengraber

This comment has been minimized.

Show comment
Hide comment
@steffengraber

steffengraber Feb 16, 2017

Contributor

@Silmathoron Thank your for reviewing.
The small changes are done.

Regarding your questions and comments about 'PrintNetwork' and 'nest.GetKernelStatus' @abigailm is better suited to give the right answer.

Contributor

steffengraber commented Feb 16, 2017

@Silmathoron Thank your for reviewing.
The small changes are done.

Regarding your questions and comments about 'PrintNetwork' and 'nest.GetKernelStatus' @abigailm is better suited to give the right answer.

@abigailm

many minor changes but otherwise good. Also, can you please turn the syntax highlighting back on?

Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
@@ -293,20 +295,25 @@ These are the new functions we introduced for the examples in this handout.

This comment has been minimized.

@abigailm

abigailm Feb 20, 2017

Contributor

there is a 'See Part 2' above, which should be a link

@abigailm

abigailm Feb 20, 2017

Contributor

there is a 'See Part 2' above, which should be a link

Show outdated Hide outdated extras/userdoc/md/documentation/part-3-connecting-networks-with-synapses.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-4-topologically-structured-networks.md Outdated
@@ -290,7 +334,8 @@ listed in NTUM Section 4.1, are:

This comment has been minimized.

@abigailm

abigailm Feb 20, 2017

Contributor

function names should be links

@abigailm

abigailm Feb 20, 2017

Contributor

function names should be links

Show outdated Hide outdated extras/userdoc/md/documentation/part-4-topologically-structured-networks.md Outdated
@Silmathoron

After 2nd reading.
Regarding @abigailm comment on syntax highlighting, I think this is processed automatically in html, so using ```python ``` would only make a difference on GitHub.

Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
@@ -120,7 +132,7 @@ dimension of the outer tuple is the length of the node list, and the dimension
of the inner tuples is the number of keys specified.
To modify the properties in the dictionary, we use `SetStatus`. In the following
example, the background current is set to $$$376.0pA$$$, a value causing the
example, the background current is set to 376.0pA, a value causing the

This comment has been minimized.

@Silmathoron

Silmathoron Feb 20, 2017

Contributor

why not keep the inline latex? $376.0 pA$

@Silmathoron

Silmathoron Feb 20, 2017

Contributor

why not keep the inline latex? $376.0 pA$

Show outdated Hide outdated ...as/userdoc/md/documentation/part-1-neurons-and-simple-neural-networks.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-2-populations-of-neurons.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-3-connecting-networks-with-synapses.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-3-connecting-networks-with-synapses.md Outdated
Show outdated Hide outdated extras/userdoc/md/documentation/part-3-connecting-networks-with-synapses.md Outdated
@jougs

This comment has been minimized.

Show comment
Hide comment
@jougs

jougs Feb 21, 2017

Contributor

I'm removing myself from the list of reviewers as this is documentation only and there are already three reviewers without me.

Contributor

jougs commented Feb 21, 2017

I'm removing myself from the list of reviewers as this is documentation only and there are already three reviewers without me.

@jougs jougs removed their request for review Feb 21, 2017

many minor changes
correcting text, linking all parts together, linking  function names
@steffengraber

This comment has been minimized.

Show comment
Hide comment
@steffengraber

steffengraber Feb 22, 2017

Contributor

Thank you @abigailm and @Silmathoron for reviewing.

I did all the minor changes that were mentioned in the last comments.

For easier reading and writing of markdown we decided for indented code blocks. They do not support syntax highlighting on Github.

Inline-Mathjax is used as least as possible, also for better reading and writing.

Contributor

steffengraber commented Feb 22, 2017

Thank you @abigailm and @Silmathoron for reviewing.

I did all the minor changes that were mentioned in the last comments.

For easier reading and writing of markdown we decided for indented code blocks. They do not support syntax highlighting on Github.

Inline-Mathjax is used as least as possible, also for better reading and writing.

@Silmathoron

Ok, this looks almost good, a few details left to correct and it should be great ;)

@abigailm abigailm self-assigned this Mar 10, 2017

@abigailm abigailm removed their assignment Mar 10, 2017

@abigailm

This comment has been minimized.

Show comment
Hide comment
@abigailm

abigailm Mar 10, 2017

Contributor

I agree with @Silmathoron 's suggestions except for the acknowledgment, so a conditional 👍

Contributor

abigailm commented Mar 10, 2017

I agree with @Silmathoron 's suggestions except for the acknowledgment, so a conditional 👍

@steffengraber

This comment has been minimized.

Show comment
Hide comment
@steffengraber

steffengraber Mar 13, 2017

Contributor

Thank you again for reviewing.
I made all the changes.

Contributor

steffengraber commented Mar 13, 2017

Thank you again for reviewing.
I made all the changes.

@Silmathoron

All good, thanks! 👍

@abigailm

This comment has been minimized.

Show comment
Hide comment
@abigailm

abigailm Mar 13, 2017

Contributor

approving 👍 and merging

Contributor

abigailm commented Mar 13, 2017

approving 👍 and merging

@abigailm abigailm merged commit 4ea4b4c into nest:master Mar 13, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@steffengraber steffengraber deleted the steffengraber:doc-pynest branch Mar 14, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment