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.

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

Add introductory text for models in documentation #2416

Merged
merged 28 commits into from
Dec 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
35f206c
update text, add table
jessica-mitchell Jun 20, 2022
37b0ecc
add text to model directory
jessica-mitchell Jun 21, 2022
82709bc
modify text, change link ref
jessica-mitchell Jun 21, 2022
165e833
remove superfluous exp
jessica-mitchell Jun 21, 2022
fc491eb
Apply suggestions from code review
jessica-mitchell Jul 4, 2022
36ff05b
add installation about nestml
jessica-mitchell Jul 4, 2022
2aec0c0
apply suggestions from review, add link to install nestml, fix up text
jessica-mitchell Jul 4, 2022
5efc6d7
apply suggestion from review - hint
jessica-mitchell Jul 4, 2022
53cf44b
Merge branch 'master' into add-intro-models
jessica-mitchell Aug 5, 2022
1def7e0
fix admonition
jessica-mitchell Aug 20, 2022
bf14add
Merge branch 'master' into add-intro-models
jessica-mitchell Aug 20, 2022
50c1be3
remove some table items, change index
jessica-mitchell Sep 19, 2022
5a69797
small fix
jessica-mitchell Sep 20, 2022
12da9f6
Merge branch 'master' into add-intro-models
jessica-mitchell Oct 14, 2022
cfefae5
link to glossary, reorganize so model abbrev in subsection, fix links…
jessica-mitchell Oct 17, 2022
9e5b40f
fixed installation nestml path, add examples
jessica-mitchell Oct 18, 2022
ed5df76
Apply suggestions from code review
jessica-mitchell Nov 11, 2022
07acc09
add note about nestml
jessica-mitchell Nov 16, 2022
ea59c75
Merge branch 'add-intro-models' of github.com:jessica-mitchell/nest-s…
jessica-mitchell Nov 16, 2022
6d3f745
rmeove spike response model
jessica-mitchell Nov 18, 2022
e3dcccb
Apply suggestions from code review
jessica-mitchell Dec 5, 2022
741d408
change wording model generation
jessica-mitchell Dec 5, 2022
43e44f9
Update doc/htmldoc/ref_material/glossary.rst
jessica-mitchell Dec 5, 2022
093016d
adjust text
jessica-mitchell Dec 5, 2022
f544796
Merge branch 'add-intro-models' of github.com:jessica-mitchell/nest-s…
jessica-mitchell Dec 5, 2022
4827d08
remove duplicate text
jessica-mitchell Dec 5, 2022
bcff8fd
Update doc/htmldoc/models/models-main.rst
jessica-mitchell Dec 6, 2022
cd4a49f
Merge branch 'master' into add-intro-models
jessica-mitchell Dec 6, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions doc/extractor_userdocs.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def UserDocExtractor(
try:
doc = rewrite_see_also(doc, filename, tags)
except ValueError as e:
log.warning("Failed to rebuild 'See also' section: %s", e)
log.info("Failed to rebuild 'See also' section: %s", e)
jessica-mitchell marked this conversation as resolved.
Show resolved Hide resolved
write_rst_files(doc, tags, outdir, outname)

log.info("%4d tags found:\n%s", len(tagdict), pformat(list(tagdict.keys())))
Expand Down Expand Up @@ -239,7 +239,7 @@ def rightcase(text):
secend = nexttitle.start()
original = doc[secstart:secend].strip().replace('\n', ' ')
if original:
log.warning("dropping manual 'see also' list in %s user docs: '%s'", filename, original)
log.info("dropping manual 'see also' list in %s user docs: '%s'", filename, original)
return (
doc[:secstart] +
"\n" + ", ".join([":doc:`{taglabel} <index_{tag}>`".format(tag=tag, taglabel=rightcase(tag))
Expand Down Expand Up @@ -344,11 +344,17 @@ def mkitem(t):

output = list()
if top:
page_title = "Model Directory"
page_title = "Model directory"
description = """
The model directory is organized and autogenerated by keywords (e.g., adaptive threshold,
conductance-based etc.). Models that contain a specific keyword will be listed under that word.
For more information on models, see our :ref:`intro to NEST models <modelsmain>`.
"""
if len(hierarchy.keys()) == 1:
page_title += ": " + ", ".join(current_tags)
output.append(page_title)
output.append(underlines[0]*len(page_title)+"\n")
output.append(description + "\n")
if len(hierarchy.keys()) != 1:
underlines = underlines[1:]

Expand Down
16 changes: 15 additions & 1 deletion doc/htmldoc/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Install NEST

.. grid:: 1 1 2 2

.. grid-item-card:: |admin| Install NEST for supercomputers and clusters
.. grid-item-card:: |admin| Install NEST for supercomputers and clusters
:class-title: sd-d-flex-row sd-align-minor-center

I'm an admin or user who wants to :ref:`run NEST on HPC <admin_install>`
Expand All @@ -29,8 +29,20 @@ Install NEST

I'm a developer who wants to :ref:`do development in NEST <dev_install>`

.. grid:: 1 1 2 2

.. grid-item-card:: |nestml| Install NEST with NESTML
:class-title: sd-d-flex-row sd-align-minor-center

I'm a user who wants to :doc:`create or customize models <nestml:installation>`.

|



----


If installation didn't work, see the :ref:`troubleshooting section <troubleshooting>`.


Expand All @@ -48,3 +60,5 @@ If installation didn't work, see the :ref:`troubleshooting section <troubleshoot
.. |teacher| image:: ../static/img/014-teacher.svg
.. |admin| image:: ../static/img/001-shuttle.svg
.. |dev| image:: ../static/img/dev_orange.svg
.. |nestml| image:: ../static/img/nestml-logo.png
:scale: 15%
4 changes: 3 additions & 1 deletion doc/htmldoc/installation/lecturer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ There are several materials for Bachelor and Master's level already prepared.
Docker install
~~~~~~~~~~~~~~

We provide a docker container for NEST, with options to include NEST-Desktop, Jupyter notebooks or Jupyterlab.
We provide a docker container for NEST that also includes NESTML. You can select from options
to also include NEST-Desktop, Jupyter Notebooks, or JupyterLab.


See :ref:`instructions for docker here <docker>`.

Expand Down
Loading