Skip to content
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.

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

Inconsistent project name and CMake options #355

Closed
pramodk opened this issue Dec 19, 2019 · 7 comments
Closed

Inconsistent project name and CMake options #355

pramodk opened this issue Dec 19, 2019 · 7 comments
Labels
build system improvement Improvement over existing implementation
Milestone

Comments

@pramodk
Copy link
Member

pramodk commented Dec 19, 2019

@tristan0x has following comment in PR here:

image

For brevity we (including Michael) prefer NRN instead of NEURON.

It would be ok to rename project name from NEURON to NRN provided that this doesn't affect other places. For example:

  • wheel should still be named as NEURON and not NRN
@nrnhines
Copy link
Member

I prefer to keep the project name as the more descriptive NEURON and also because that has been
its face to the world for many years. Internal code names are generally the short nrn form. I do believe
there is a kind of consistency in all this except for a few cases. NEURON generally refers to the large ecosystem and is also occasionally referred to as The NEURON Simulation Environment

@pramodk
Copy link
Member Author

pramodk commented Dec 20, 2019

I also see the point of having NRN as well as NEURON in different context.

I created this issue because we are using some utilities for code-formatting which automatically creates CMake options by using project name i.e.

If we enable code formatting as:

$ cmake .. -DNEURON_CMAKE_FORMAT=ON -DPYTHON_EXECUTABLE=`which python3`

Then following CMake variables are created:

image

One way would be to optionally tell coding-convention utility to use NRN instead of project name.

Is that possible @tristan0x ?

cc: @ohm314

@nrnhines
Copy link
Member

If the coding convention utility can be made to use NRN then great. Otherwise I think the only choice is to leave some mixed NEURON and NRN or to universally in cmake change all NRN to NEURON. I don't mind except for the trivial extra name lengths and the cursing that results when one types NERUON

@ohm314
Copy link
Member

ohm314 commented Feb 5, 2020

I think we should be able to adjust hpc-coding-conventions to take the desired name. If that is not possible, I also opt for using "NEURON" everywhere (and do some cursing :) )

@nrnhines
Copy link
Member

nrnhines commented Feb 5, 2020

everywhere @ohm314

I'm guessing your context is a bit narrower than that and refers only to the cmake options. The reasons NRN and nrn are so ubiquitous is their convenience. The 'nrniv', 'nrnoc', letter groups as well as strange names like nocmodl had perfectly reasonable origins in the oc, nrnoc, ivoc, nrniv folder structure but don't make as much sense as they used to.

@ohm314
Copy link
Member

ohm314 commented Feb 11, 2020

Yes, I meant in the context of cmake / the build system. in the source code I would think there is no need to rush with radical name changes and rather change names whenever it makes sense and eases maintenance or clarifies code.

@ohm314 ohm314 added this to the Release v8.0 milestone May 4, 2020
@pramodk
Copy link
Member Author

pramodk commented May 8, 2020

@ohm314 has done necessary change in BlueBrain/hpc-coding-conventions@0673881

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build system improvement Improvement over existing implementation
Projects
None yet
Development

No branches or pull requests

3 participants