search

itesla / ipsl

The iTesla Power System Library is a Modelica library developed as part of the iTesla project. The library contains a set of power system component models for phasor time domain simulations.
Mozilla Public License 2.0
23 stars 71 forks source link

Name of the Library #6

Open tinrabuzin opened 8 years ago

tinrabuzin commented 8 years ago

Can we keep the capitalisation of the names as it is defined in Modelica (iPSL) and by project (iTesla)? Also, I wasn't sure if I was in the right repository before I looked at the files because of @itesla's profile photo. Can we maybe change this to the iTesla Logo?

lvanfretti commented 8 years ago

@itesla is Geoffrey for the time being... yes, we should put the logo.

@tinrabuzin I don't really understand your first question...

MaximeBaudette commented 8 years ago

@lvanfretti What @tinrabuzin means and I agree with him: itesla/ipsl as a team name and repository name doesn't look as nice as iTesla/iPSL.

itesla commented 8 years ago

I replaced my face by iTesla logo, much better...

itesla commented 8 years ago

@MaximeBaudette maybe nice but not very convenient. Upper cases are often avoided in coding style guides just because it slows down writing. Lower case and dash is better and more standard for login, repository name and also package name.

tinrabuzin commented 8 years ago

@itesla Here's a logo with a bit more pixels in it, if you're interested. :) https://www.dropbox.com/s/228j73dqg00xcam/logo-color.jpg?dl=0

Also, I disagree with the names (there are plenty of examples on github).

tbeu commented 8 years ago

It's kind of a Modelica naming convention that class names (except functions) shall start with an upper case letter, i.e. the package iPSL needs to be renamed to IPSL.

geofjamg commented 8 years ago

@tbeu Camel case convention is very common for class naming in lots of languages but for package naming it is often different. What about Modelica?

tbeu commented 8 years ago

There is some common sense that in Modelica Camel case is fine as long as first letter is upper letter for packages, models, connectors, blocks etc. Function names should start with lower-case letter.

dietmarw commented 8 years ago

In addition, instance of classes start with non-capital letter. This makes it easier to see if something is an instance of something or the source. Just a convention (see also Modelica.UsersGuide.Conventions.ModelicaCode.Naming).

MaximeBaudette commented 8 years ago

@lvanfretti @fran-jo Could you take up the following question in the upcoming iTesla meeting: Should we keep the package as iPSL or change it to IPSL?

iPSL: reminds more of the name: iTesla Power System Library IPSL: compliant with the Modelica naming convention

If you take up that discussion with everyone in the meeting, I can close this discussion and do as you all decided.

fran-jo commented 8 years ago

It is true that IPSL follows better the naming conventions that Modelica define. However, I think is good to define our library with some characteristic that make it different from the standard naming conventions (even though we keep some capital letters, PSL). Then, users will easy identify the library with our project.

tbeu commented 8 years ago

I'd strongly recommend to follow the Modelica naming convention here w/o exception.

MaximeBaudette commented 8 years ago

@tbeu your concerns will be relayed by @fran-jo in the iTesla meeting happening tomorrow. The decision will be taken and I will apply whatever is decided.

lvanfretti commented 8 years ago

@MaximeBaudette Thanks for reminding us.

I have unlocked the conversation to get some additional feedback today. I'm not sure if we can reach a consensus during the meeting, and I think we can get good technical arguments from @dietmarw and @tbeu for compatibility with Modelica.

The main and most important aspect of this library is transparency to the user from the power systems community (even if some things look weird for the Modelica expert, but are still valid) - to avoid issues with resistance to change, and after that Modelica compatibility.

@MaximeBaudette I will highlight today that people that wants to be involved in the library must do so through this system, for practical and resource reasons mostly, but also for transparency and documentation.

dietmarw commented 8 years ago

We discussed this "internally" a bit. And technically the only potential issue would be name sorting. So it can happen that iPSL appears right at the end of a library listing. Other "non-technical" issues would be (Modelica) user expectancy that package names normally start with capital letters and hence might lead to typos when writing code as Modelica is case-sensitive. Or it might be mistaken as a function call rather then a package name. So as far as I can say it would not break anything in the tool as it is a legal name that simply does not follow conventions which in turn can lead to confusion.