Wheel that supports MUSIC if installed.

[nrnhines]

A beginning...
Extends #2092 (dynamic loading of MUSiC) which extends #1896 (reenable MUSIC support on a build machine).

How to test wheels locally for this PR

• download MUSIC enabled docker image

  docker pull neuronsimulator/neuron_wheel:music
  

• If MUSIC 1.2.0 needs adjustments, you need to build the docker image locally
  https://nrn.readthedocs.io/en/8.2.2/install/python_wheels.html#building-the-docker-image

  cd nrn/packaging/python
  # update Dockerfile
  docker build -t neuronsimulator/neuron_wheel:music .
  

• run the docker image
  https://nrn.readthedocs.io/en/8.2.2/install/python_wheels.html#using-the-docker-image

  docker run -v $PWD/nrn:/root/nrn -w /root/nrn -it neuronsimulator/neuron_wheel:music bash
  

• build the wheel
  https://nrn.readthedocs.io/en/8.2.2/install/python_wheels.html#launch-the-wheel-building

   # i.e. for python 3.8, make sure to add the coreneuron tag
   bash packaging/python/build_wheels.bash linux 38 coreneuron
  

• from outside the docker shell, test the wheel on the host system:
  https://nrn.readthedocs.io/en/8.2.2/install/python_wheels.html#testing-the-wheels

  bash packaging/python/test_wheels.sh python3.8 nrn/wheelhouse/NEURON-X.Y.Z-cp38-cp38-x86_64.whl
  

[azure-pipelines]

✔️ c9dd9fb -> Azure artifacts URL

[bbpbuildbot]

Logfiles from GitLab pipeline #108153 (:white_check_mark:) have been uploaded here!

Status and direct links:

• ✅ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ✅ build:neuron:mod2c:intel:shared
• ✅ build:neuron:nmodl:intel:legacy
• ✅ build:neuron:nmodl:intel:shared
• ✅ build:neuron:mod2c:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:acc:legacy
• ✅ build:neuron:nmodl:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:omp:legacy
• ✅ build:neuron:nmodl:nvhpc:omp
• ✅ test:neuron:mod2c:intel:shared
• ✅ test:neuron:nmodl:intel:legacy
• ✅ test:neuron:nmodl:intel:shared
• ✅ test:neuron:mod2c:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:acc:legacy
• ✅ test:neuron:nmodl:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:omp:legacy
• ✅ test:neuron:nmodl:nvhpc:omp

[bbpbuildbot]

Logfiles from GitLab pipeline #108487 (:no_entry:) have been uploaded here!

Status and direct links:

• ✅ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ✅ build:neuron:mod2c:intel:shared
• ✅ build:neuron:nmodl:intel:legacy
• ✅ build:neuron:nmodl:intel:shared
• ✅ build:neuron:mod2c:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:acc:legacy
• ✅ build:neuron:nmodl:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:omp:legacy
• ✅ build:neuron:nmodl:nvhpc:omp
• ✅ test:neuron:mod2c:intel:shared
• ✅ test:neuron:nmodl:intel:legacy
• ✅ test:neuron:nmodl:intel:shared
• ✅ test:neuron:mod2c:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:acc:legacy
• ✅ test:neuron:nmodl:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:omp:legacy
• ✅ test:neuron:nmodl:nvhpc:omp

[bbpbuildbot]

Logfiles from GitLab pipeline #108577 (:no_entry:) have been uploaded here!

Status and direct links:

• ✅ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ✅ build:neuron:mod2c:intel:shared
• ✅ build:neuron:nmodl:intel:legacy
• ✅ build:neuron:nmodl:intel:shared
• ✅ build:neuron:mod2c:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:acc:legacy
• ✅ build:neuron:nmodl:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:omp:legacy
• ✅ build:neuron:nmodl:nvhpc:omp
• ✅ test:neuron:mod2c:intel:shared
• ✅ test:neuron:nmodl:intel:legacy
• ✅ test:neuron:nmodl:intel:shared
• ✅ test:neuron:mod2c:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:acc:legacy
• ✅ test:neuron:nmodl:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:omp:legacy
• ✅ test:neuron:nmodl:nvhpc:omp

[bbpbuildbot]

Logfiles from GitLab pipeline #108995 (:white_check_mark:) have been uploaded here!

Status and direct links:

• ✅ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ✅ build:neuron:mod2c:intel:shared
• ✅ build:neuron:nmodl:intel:legacy
• ✅ build:neuron:nmodl:intel:shared
• ✅ build:neuron:mod2c:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:acc:legacy
• ✅ build:neuron:nmodl:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:omp:legacy
• ✅ build:neuron:nmodl:nvhpc:omp
• ✅ test:neuron:mod2c:intel:shared
• ✅ test:neuron:nmodl:intel:legacy
• ✅ test:neuron:nmodl:intel:shared
• ✅ test:neuron:mod2c:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:acc:legacy
• ✅ test:neuron:nmodl:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:omp:legacy
• ✅ test:neuron:nmodl:nvhpc:omp

[bbpbuildbot]

Logfiles from GitLab pipeline #109243 (:no_entry:) have been uploaded here!

Status and direct links:

• ✅ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ✅ build:neuron:mod2c:intel:shared
• ✅ build:neuron:nmodl:intel:legacy
• ✅ build:neuron:nmodl:intel:shared
• ✅ build:neuron:mod2c:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:acc:legacy
• ✅ build:neuron:nmodl:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:omp:legacy
• ✅ build:neuron:nmodl:nvhpc:omp
• ✅ test:neuron:mod2c:intel:shared
• ✅ test:neuron:nmodl:intel:legacy
• ✅ test:neuron:nmodl:intel:shared
• ✅ test:neuron:mod2c:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:acc:legacy
• ✅ test:neuron:nmodl:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:omp:legacy
• ✅ test:neuron:nmodl:nvhpc:omp

[bbpbuildbot]

Logfiles from GitLab pipeline #109411 (:white_check_mark:) have been uploaded here!

Status and direct links:

• ✅ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ✅ build:neuron:mod2c:intel:shared
• ✅ build:neuron:nmodl:intel:legacy
• ✅ build:neuron:nmodl:intel:shared
• ✅ build:neuron:mod2c:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:acc:legacy
• ✅ build:neuron:nmodl:nvhpc:acc:shared
• ✅ build:neuron:nmodl:nvhpc:omp:legacy
• ✅ build:neuron:nmodl:nvhpc:omp
• ✅ test:neuron:mod2c:intel:shared
• ✅ test:neuron:nmodl:intel:legacy
• ✅ test:neuron:nmodl:intel:shared
• ✅ test:neuron:mod2c:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:acc:legacy
• ✅ test:neuron:nmodl:nvhpc:acc:shared
• ✅ test:neuron:nmodl:nvhpc:omp:legacy
• ✅ test:neuron:nmodl:nvhpc:omp

[alexsavulescu]

Status - blocked

Ok so this is hitting a blocking snag.

Issue

Long story short, shipping C++ features in wheels (i.e. std::string in this case) can yield ABI issues (see relevant discussion in #1963)

Details

# On my ubuntu
(nrn_test_venv_310) savulesc@bbd-cjngk03:~/Workspace/nrn$ python test/music_tests/runtests.py
MUSIC_LIBDIR: /nrnwheel/MUSIC/lib
MUSIC located in: /nrnwheel/MUSIC/lib
MUSIC_BINPATH: /nrnwheel/MUSIC/bin:
NRN_ENABLE_MPI_DYNAMIC=ON
NRN_LIBMUSIC_PATH=/nrnwheel/MUSIC/lib/libmusic.so
PATH: /nrnwheel/MUSIC/bin:/home/savulesc/Workspace/nrn/nrn_test_venv_310/bin:/home/savulesc/.local/bin:/home/savulesc/bin:/home/savulesc/.local/bin:/home/savulesc/bin:/usr/local/Modules/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/snap/bin:/opt/puppetlabs/bin:/home/savulesc/.local/share/JetBrains/Toolbox/scripts:/home/savulesc/.local/share/JetBrains/Toolbox/scripts
/home/savulesc/Workspace/nrn/nrn_test_venv_310/lib/python3.10/site-packages/neuron/.data/lib/libnrnmusic.so: undefined symbol: _ZN5MUSIC4PortC2EPNS_5SetupESs
...
subprocess.CalledProcessError: Command 'mpiexec  -n  2 /nrnwheel/MUSIC/bin/music test2.music' returned non-zero exit status 1.
(nrn_test_venv_310) savulesc@bbd-cjngk03:~/Workspace/nrn$ c++filt _ZN5MUSIC4PortC2EPNS_5SetupESs
MUSIC::Port::Port(MUSIC::Setup*, std::basic_string<char, std::char_traits<char>, std::allocator<char> >)
(nrn_test_venv_310) savulesc@bbd-cjngk03:~/Workspace/nrn$ nm -A /nrnwheel/MUSIC/lib/libmusic.so | xargs c++filt | grep MUSIC::Port::Port
MUSIC::Port::Port(MUSIC::Setup*, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)
MUSIC::Port::Port(MUSIC::Setup*, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)
MUSIC::Port::Port(MUSIC::Setup*, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >) [clone .cold]

# On the docker image
[root@f23f375dfb64 nrn]# nm -A /opt/nrnwheel/MUSIC/lib/libmusic.so | xargs c++filt | grep MUSIC::Port::Port
MUSIC::Port::Port(MUSIC::Setup*, std::basic_string<char, std::char_traits<char>, std::allocator<char> >)
MUSIC::Port::Port(MUSIC::Setup*, std::basic_string<char, std::char_traits<char>, std::allocator<char> >)
MUSIC::Port::Port(MUSIC::Setup*, std::basic_string<char, std::char_traits<char>, std::allocator<char> >) [clone .cold]

What next?

On thing that could work is if MUSIC provided a C-API, i.e. EventOutputPort(MUSIC::Setup* s, char* id), maybe that would alleviate the wheel portability issues. Some experimentation is in order to see if that works out (I am not familiar with MUSIC code & interplay).

cc @mdjurfeldt @nrnhines

[mdjurfeldt]

@alexsavulescu @nrnhines Hi, sorry but I saw this first now that Alex brought it to my attention.

I guess it is the std::string argument which is the problem? Would it help if I would overload the Port constructor such that it can take a C string? In that case you could cast the argument to a C string.

Also, MUSIC does provide a C api (in music-c.h). NEURON could use that instead of the C++ API, but could we maybe try out the solution I suggest above first? Do you need help from me to try it out? I don't think that I easily could reproduce this error...

[alexsavulescu]

@mdjurfeldt unfortunately I haven't explored the MUSIC code yet, but it is encouraging that there is a C-API. Regarding the overload, I'm not sure, but if the MUSIC classes that we inherit from in NEURON have std::string as data members , then I believe that is not going to work out. I don't know when I'll be able to revisit the wheel integration, I can however point out how to use docker to build wheels locally and then test them on the host platform. In the meantime that will give you time to work out the licensing aspects.

[mdjurfeldt]

Yes, please give me advice how to reproduce the error.

[alexsavulescu]

Yes, please give me advice how to reproduce the error.

PR description updated with how-to