Skip to content

Add documentation about module unloading behaviour #43

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.

Sign up for GitHub

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

Open
clinssen wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

Add documentation about module unloading behaviour #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions doc/extension_modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ To use the new module in NEST Simulator, ensure that the ``PYTHONPATH`` environm
After loading the module, you should be able to see ``pif_psc_alpha`` in ``nest.node_models`` and ``drop_odd_spike`` in ``nest.synapse_models``.


Reloading the module
^^^^^^^^^^^^^^^^^^^^

The ``nest.ResetKernel()`` call unloads all user extension modules. However, note that some systems do not unload dynamic library symbols (see https://github.com/nest/nest-simulator/issues/3802); as a result of this, it is recommended to always use unique names for models inside modules, or, alternatively, use the ``-fno-gnu-unique`` flag when building NEST extension modules.


Creating your own module
------------------------

Expand Down
Loading