Skip to content

Commit

Permalink
Remove feature checkpoint (#3092)
Browse files Browse the repository at this point in the history
This feature has never been completed and is replaced by SaveState.
  • Loading branch information
alkino authored Sep 24, 2024
1 parent 956ae01 commit dc9d4c9
Show file tree
Hide file tree
Showing 55 changed files with 47 additions and 1,459 deletions.
1 change: 0 additions & 1 deletion cmake/NeuronFileLists.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,6 @@ set(IVOC_FILE_LIST
axis.cpp
bndedval.cpp
cbwidget.cpp
checkpnt.cpp
epsprint.cpp
fourier.cpp
gifimage.cpp
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/hoc_chapter_11_old_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ Keywords
string_dialog doEvents doNotify numarg hoc_pointer_
execute execute1 load_proc load_func load_template
machine_name saveaudit retrieveaudit coredump_on_error
checkpoint quit object_push object_pop pwman_place
quit object_push object_pop pwman_place
show_errmess_always numprocs myproc psync settext
secname
Expand Down
31 changes: 0 additions & 31 deletions docs/hoc/simctrl/programmatic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -346,37 +346,6 @@ Functions

----

.. hoc:function:: checkpoint
Syntax:
:samp:`checkpoint("{filename}")`

Description:
saves the current state of the system in a portable file to
allow one to take up where you left off -- possibly on another
machine. Returning to this state is accomplished by running the
program with the checkpoint file as the first argument.
If the checkpoint file is inconsistent with the executable the
program prints an error message and exits.

At this time many portions of the computer state are left out of the
checkpoint file, i.e. it is not as complete as a core dump.
Some things that ARE included are:
all interpreter symbols with definitions and values,
all hoc instructions,
all neuron state/parameters with mechanisms.
Many aspects of the GUI are not included.

.. warning::
There is not enough implementation at this time to make this
facility useful. Use the :hoc:class:`SaveState` class instead.




----


.. _hoc_finithnd:


Expand Down
30 changes: 0 additions & 30 deletions docs/python/simctrl/programmatic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -345,36 +345,6 @@ Functions
It is cleared at the beginning of a run or when continuing a run.


----

.. function:: checkpoint

Syntax:
:samp:`h.checkpoint("{filename}")`

Description:
saves the current state of the system in a portable file to
allow one to take up where you left off -- possibly on another
machine. Returning to this state is accomplished by running the
program with the checkpoint file as the first argument.
If the checkpoint file is inconsistent with the executable the
program prints an error message and exits.

At this time many portions of the computer state are left out of the
checkpoint file, i.e. it is not as complete as a core dump.
Some things that ARE included are:
all interpreter symbols with definitions and values,
all hoc instructions,
all neuron state/parameters with mechanisms.
Many aspects of the GUI are not included.

.. warning::
There is not enough implementation at this time to make this
facility useful. Use the :class:`SaveState` class instead.




----

.. _finithnd:
Expand Down
1 change: 0 additions & 1 deletion share/lib/helpdict
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Changeparmfromlist Extras RunFitter StandardRunTools GUI Reference 449 neuron/st
ChangeText Graph LookAndFeel GUI Reference 18 neuron/agui/gui.html#ChangeText
Channels ModelDescriptionIssues CVode classes neuron neuron.exe Reference 258 neuron/neuron/classes/cvode.html#Channels
chdir functions general neuron.exe Reference 177 neuron/general/function/0fun.html#chdir
checkpoint functions general neuron.exe Reference 179 neuron/general/function/checkpnt.html#checkpoint
child SectionRef classes neuron neuron.exe Reference 320 neuron/neuron/classes/secref.html#child
children SectionList classes neuron neuron.exe Reference 317 neuron/neuron/classes/seclist.html#children
chooser File classes general neuron.exe Reference 32 neuron/general/classes/file.html#chooser
Expand Down
Loading

0 comments on commit dc9d4c9

Please sign in to comment.