Convert NEURON simulator .HOC files to .SWC morphology format
hoc2swc: A Python package to convert NEURON cell HOC files to SWC morphology files
hoc2swc is a Python library that converts the morphology of neuron models defined using NEURON simulator HOC files to the popular SWC morphology format. The library can also be used to convert cell morphologies instantiated in NEURON simulator (e.g. models that were build using NEURON+Python).
You must be able to run at least one of these commands in a terminal window without errors:
python -c 'from neuron import h'
If you cannot run any of these commands, it indicates that there is something amiss with your NEURON installation. Search the error messages on the NEURON forum for help.
Installation and Usage
Installation and usage depends on how you installed NEURON simulator (installed vs. compiled). More customizable functionality is available for those who compiled.
If you installed a downloaded NEURON package
Download and extract this hoc2swc ZIP file to a known folder. This folder will have a script named
hoc2swc.py. Note its location.
Then, to convert a HOC file, run the following command in terminal (note the '-'s before the hoc and swc paths):
nrniv -python path/to/hoc2swc.py -path/to/cell.hoc -path/to/converted.swc
If you compiled NEURON+Python
To install the library, simply type in
pip install hoc2swc in your terminal.
Then in a Python session, run the following to convert a HOC file to SWC.
from hoc2swc import hoc2swc hoc2swc("path/to/cell.hoc", "out.swc")
Exporting non-HOC cells
If a cell is not defined in a HOC file (e.g. defined using a custom script or using Python), you can instantiate the cell in NEURON and when it is ready for export to SWC, use the following Python script lines:
# Load your cell from neuron import h run_scripts_build_cell_etc() # Export loaded cell to SWC from hoc2swc import neuron2swc neuron2swc("out.swc")
Note to packaged NEURON users, if you start
nrniv -python from the directory where the hoc2swc.py file is located OR append the location to the PYTHONPATH environment variable, the above lines will work for you as well.
If you encounter an issues, first make sure it's not due to NEURON itself -- this library simply interacts with the NEURON executables. If it is, please contact the NEURON team. If the issue is with this library, please create an issue on Github.
To contribute, please open an issue first and discuss your plan for contributing. Then fork this repository and commit a pull-request with your changes.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.