Skip to content

Commit

Permalink
Removed line about bug in coreneuron, fixed code blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
st4rl3ss committed Dec 2, 2024
1 parent 79ab997 commit baa697c
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/memory_load_balance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ then a neurodamus model instantiation with no simulation, a rebalance and then f

Dry Run
-------
.. code_block:: bash
.. code-block:: bash
$ neurodamus ... --dry-run
Expand All @@ -28,14 +28,14 @@ By default, the balance distribution will happen on the amount of nodes/ranks th
However you can manually specify the amount of ranks you want to distribute on by using the `--num-target-ranks`` option.
So, for example, let's say you want to distribute over 100 ranks, you can run neurodamus with:

.. code_block:: bash
.. code-block:: bash
$ neurodamus ... --configFile=simulation_config.json --dry-run --num-target-ranks=100
Model Instantiation
-------------------
.. code_block:: bash
.. code-block:: bash
$ neurodamus ... --lb-mode=Memory --simulate-model=OFF
Expand All @@ -45,7 +45,7 @@ we want to use the memory load balancing for this step, even without simulating.
This will create the model in the specified output folder and will be used for the rebalance step.
The model will be saved in the output folder specified using the `--output-path` option.

.. code_block:: bash
.. code-block:: bash
$ neurodamus ... --lb-mode=Memory --configFile=simulation_config.json --simulate-model=OFF --output-path=/path/to/output
Expand All @@ -55,7 +55,8 @@ Balancing for CoreNeuron, especially using multi-cycle, can distribute gids unop
In order to mitigate these issues we have implemented a post processing rebalance step that will redistribute the gids
evenly across the machines, based on the data collected in the previous phases.
You will find the `rebalance-corenrn-data.py` script in the `neurodamus/tools` folder and you can run it with:
.. code_block:: bash

.. code-block:: bash
$ python3 rebalance-corenrn-data.py input_file.dat n_machines --output-file rebalanced_file.dat
Expand All @@ -72,10 +73,8 @@ Simulation

Finally we can run the simulation with the rebalanced data using coreneuron.

.. code_block:: bash
.. code-block:: bash
$ special-core -d /path/to/coreneuron_input -f /path/to/rebalanced_file.dat
This will run the simulation using the rebalanced data and should distribute the memory usage more evenly across the machines.
(Due to a bug in coreneuron, make sure that the `rebalanced_file.dat` is present both in the `coreneuron_input` folder
and in the cwd where you run the simulation)

0 comments on commit baa697c

Please sign in to comment.