Skip to content

Commit 0782ed7

Browse files
change all NEST simulators to Simulators
1 parent e899520 commit 0782ed7

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contribute to NEST
22

3-
The NEST simulator is a scientific tool and as such it is never finished and constantly changing to meet the needs of novel neuroscientific endeavors. Here you find the most important information on how you can contribute to NEST. This document is an excerpt from our [Contributing to NEST documentation](https://nest-simulator.readthedocs.io/en/latest/contribute/index.html), which provides more detailed information.
3+
The NEST Simulator is a scientific tool and as such it is never finished and constantly changing to meet the needs of novel neuroscientific endeavors. Here you find the most important information on how you can contribute to NEST. This document is an excerpt from our [Contributing to NEST documentation](https://nest-simulator.readthedocs.io/en/latest/contribute/index.html), which provides more detailed information.
44

55

66
* Make sure you have a [GitHub account](https://github.com/signup/free)

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# Security Policy
33

4-
The NEST simulator is research oriented software and as such is expected to
4+
The NEST Simulator is research oriented software and as such is expected to
55
run mainly in well protected environments. In case it is found that this
66
software can be used to violate security mechanisms, developers will try to
77
provide patches that mitigate the risk of this misuse.

doc/htmldoc/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
}
117117

118118
# General information about the project.
119-
project = u'NEST simulator user documentation'
119+
project = u'NEST Simulator user documentation'
120120
copyright = u'2004, nest-simulator'
121121
author = u'nest-simulator'
122122

@@ -157,7 +157,7 @@
157157
# a list of builtin themes.
158158
#
159159
html_theme = 'sphinx_material'
160-
html_title = 'NEST simulator documentation'
160+
html_title = 'NEST Simulator Documentation'
161161
html_logo = str(doc_build_dir / 'static/img/nest_logo.png')
162162

163163
# Theme options are theme-specific and customize the look and feel of a theme
@@ -182,7 +182,7 @@
182182
'master_doc': True,
183183
# Set the repo location to get a badge with stats
184184
'repo_url': 'https://github.com/nest/nest-simulator/',
185-
'repo_name': 'NEST simulator',
185+
'repo_name': 'NEST Simulator',
186186
# "nav_links": [
187187
# {"href": "index", "internal": True, "title": "NEST docs home"}
188188
# ],
@@ -304,7 +304,7 @@ def setup(app):
304304
# One entry per manual page. List of tuples
305305
# (source start file, name, description, authors, manual section).
306306
man_pages = [
307-
(master_doc, 'nestsimulator', u'NEST simulator Documentation',
307+
(master_doc, 'nestsimulator', u'NEST Simulator Documentation',
308308
[author], 1)
309309
]
310310

@@ -315,7 +315,7 @@ def setup(app):
315315
# (source start file, target name, title, author,
316316
# dir menu entry, description, category)
317317
texinfo_documents = [
318-
(master_doc, 'NESTsimulator', u'NEST simulator Documentation',
318+
(master_doc, 'NESTsimulator', u'NEST Simulator Documentation',
319319
author, 'NESTsimulator', 'One line description of project.',
320320
'Miscellaneous'),
321321
]

doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ documentation. To learn more about the syntax, check out this `quick
1313
reference
1414
<https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html>`_.
1515

16-
The NEST simulator documentation lives alongside its code. It is
16+
The NEST Simulator documentation lives alongside its code. It is
1717
contained in the ``doc/htmldoc`` directory within the `NEST source
1818
code repository <https://github.com/nest/nest-simulator>`_ on GitHub.
1919

@@ -127,7 +127,7 @@ sphinx/rest_syntax.html>`_ files or to create new ones, follow the steps below:
127127

128128
2. If you create a new page, open ``index.rst`` in the ``doc/htmldoc`` directory
129129
and add the file name under ``.. toctree::``. This will ensure it appears on
130-
the NEST simulator documentation's table of contents.
130+
the NEST Simulator documentation's table of contents.
131131

132132
3. If you rename or move a file, please make sure you update all the
133133
corresponding cross-references.
@@ -164,7 +164,7 @@ Docs.
164164
import-guide.html#building-your-documentation>`_ your documentation.
165165

166166
This allows you to preview your work on your Read the Docs account. In order
167-
to see the changes on the official NEST simulator documentation, please submit
167+
to see the changes on the official NEST Simulator documentation, please submit
168168
a pull request.
169169

170170
Creating pull request

doc/htmldoc/related_projects.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Related projects
44
================
55

6-
NEST simulator is part of a larger network of projects that focus on simulation, analysis, visualization, or modeling of
6+
NEST Simulator is part of a larger network of projects that focus on simulation, analysis, visualization, or modeling of
77
biologically realistic neural networks.
88

99
Here you can find further information about some of these projects.

doc/htmldoc/templates/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<div class="wrapper">
4646
<div class="row">
4747
<div class="grid_3">
48-
<h1>Welcome to the NEST simulator documentation!</h1>
48+
<h1>Welcome to the NEST Simulator documentation!</h1>
4949
<a href="installation/index.html" class="buttonlink">Install NEST</a>
5050

5151
</div>

doc/htmldoc/tutorials/pynest_tutorial/part_1_neurons_and_simple_neural_networks.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Networks <pynest_examples>`, or
3131
have a look at at the source directory of your NEST installation in the
3232
subdirectory: ``pynest/examples/``.
3333

34-
PyNEST - an interface to the NEST simulator
34+
PyNEST - an interface to the NEST Simulator
3535
-------------------------------------------
3636

3737
.. _Python-Interface:
@@ -42,7 +42,7 @@ PyNEST - an interface to the NEST simulator
4242

4343
Python Interface Figure.
4444
The Python interpreter imports NEST as a module and
45-
dynamically loads the NEST simulator kernel (``pynestkernel.so``).
45+
dynamically loads the NEST Simulator kernel (``pynestkernel.so``).
4646
A simulation script of
4747
the user (``mysimulation.py``) uses functions defined in this high-level
4848
API. These functions generate code in SLI (Simulation Language
@@ -54,7 +54,7 @@ is designed for the simulation of large heterogeneous networks of point
5454
neurons. It is open source software released under the GPL licence. The
5555
simulator comes with an interface to Python [2]_. :numref:`Python-Interface`
5656
illustrates the interaction between the user's simulation script
57-
(``mysimulation.py``) and the NEST simulator. Eppler et al. [3]_
57+
(``mysimulation.py``) and the NEST Simulator. Eppler et al. [3]_
5858
contains a technically detailed description of the implementation of this
5959
interface and parts of this text are based on this reference. The
6060
simulation kernel is written in C++ to obtain the highest possible performance
@@ -568,7 +568,7 @@ References
568568
.. [2] Python Software Foundation. The Python programming language,
569569
2008. http://www.python.org.
570570
571-
.. [3] Eppler JM et al. 2009 PyNEST: A convenient interface to the NEST simulator.
571+
.. [3] Eppler JM et al. 2009 PyNEST: A convenient interface to the NEST Simulator.
572572
2:12. 10.3389/neuro.11.012.2008.
573573
574574
.. [4] Hunter JD. 2007 Matplotlib: A 2d graphics environment.

pynest/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ References
3636
----------
3737

3838
.. [1] Zaytsev YV and Morrison A (2014) CyNEST: a maintainable
39-
Cython-based interface for the NEST simulator. Front.
39+
Cython-based interface for the NEST Simulator. Front.
4040
Neuroinform. 8:23. http://dx.doi.org/10.3389/fninf.2014.00023
4141
4242
.. [2] Eppler JM, Helias M, Muller E, Diesmann M and Gewaltig M-O PyNEST
43-
(2009) A convenient interface to the NEST simulator. Front.
43+
(2009) A convenient interface to the NEST Simulator. Front.
4444
Neuroinform. 2:12. http://dx.doi.org/10.3389/neuro.11.012.2008

pynest/nest/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# You should have received a copy of the GNU General Public License
2020
# along with NEST. If not, see <http://www.gnu.org/licenses/>.
2121

22-
r"""PyNEST - Python interface for the NEST simulator
22+
r"""PyNEST - Python interface for the NEST Simulator
2323
2424
* ``nest.helpdesk()`` opens the NEST documentation in your browser.
2525

0 commit comments

Comments
 (0)