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

Change the "viewer" to use an official name #400

Open
yungyuc opened this issue Jul 31, 2024 · 12 comments
Open

Change the "viewer" to use an official name #400

yungyuc opened this issue Jul 31, 2024 · 12 comments
Labels
viewer Visualize stuff

Comments

@yungyuc
Copy link
Member

yungyuc commented Jul 31, 2024

The "viewer" GUI app was named like that because "viewer" is a placeholder name. After fixing the Mac app icon (PR #398), we can start to give the GUI app an official name.

It could take a while. This issue is created to track the progress of naming.

@yungyuc yungyuc added the viewer Visualize stuff label Jul 31, 2024
@tigercosmos
Copy link
Collaborator

How about "MeshView"?

@yungyuc
Copy link
Member Author

yungyuc commented Aug 1, 2024

How about "MeshView"?

It's too specific. The GUI app also houses solvers and a lot of other computation like the time-series analysis.

@tigercosmos
Copy link
Collaborator

How about "MeshView"?

It's too specific. The GUI app also houses solvers and a lot of other computation like the time-series analysis.

Then how about SolverView?

@yungyuc
Copy link
Member Author

yungyuc commented Aug 1, 2024

"View" probably should not be in the name because viewing is only a fraction of the features.

@Tucchhaa
Copy link
Contributor

Tucchhaa commented Sep 1, 2024

All the interaction of the user with modmesh happens through viewer, right? Then, how about just call it "modmesh"?

@tigercosmos
Copy link
Collaborator

Maybe "Mesh" is even better, because "mod" means "module".

@yungyuc
Copy link
Member Author

yungyuc commented Sep 2, 2024

All the interaction of the user with modmesh happens through viewer, right? Then, how about just call it "modmesh"?

The project contains both non-GUI and GUI parts. If the project name is used to refer the GUI part, it will be hard to refer to the non-GUI part.

Assuming the GUI part is named as "modmesh", the sentence "the non-GUI part of modmesh" becomes illogical.

Maybe "Mesh" is even better, because "mod" means "module".

It is truthful that by "mod" I meant "module", but I am surprised that you know it, @tigercosmos. Did I mention it to you before?

"Mesh" sounds good to me too! It has another concern: how do we refer to a mesh shown in the "Mesh" GUI? It reads a little bit misleading to write a sentence like "Create 3 meshes in Mesh".

@Tucchhaa
Copy link
Contributor

Tucchhaa commented Sep 2, 2024

The project contains both non-GUI and GUI parts. If the project name is used to refer the GUI part, it will be hard to refer to the non-GUI part.

I tried to think like a user. If I installed a project named 'modmesh', then there should be an '.exe' or '.app' (in case of macos) that I can execute with the name 'modmesh'.

If the only entry point to use modmesh, is the viewer, then imho it's the most user-friendly name.

If it's not, then what do you think about 'modmesh-gui'?

And I have a question, how can I use modmesh without viewer?

@tigercosmos
Copy link
Collaborator

Did I mention it to you before?

@yungyuc Nope, but it's straightforward.

"Create 3 meshes in Mesh"

@yungyuc I don't think it's an issue, though. Many projects are using super simple words as well.

And I have a question, how can I use modmesh without viewer?

@Tucchhaa modmesh can function as a library. See how the pytests and gtests work.

I can execute with the name 'modmesh'.

@Tucchhaa modmesh is just a temporary name, we will give the project an official name later.

Overall, I propose that the GUI be called "Mesh", and the library be called "modmesh" (maybe "libmesh" or "pymesh" is better).

@yungyuc
Copy link
Member Author

yungyuc commented Sep 2, 2024

The project contains both non-GUI and GUI parts. If the project name is used to refer the GUI part, it will be hard to refer to the non-GUI part.

I tried to think like a user. If I installed a project named 'modmesh', then there should be an '.exe' or '.app' (in case of macos) that I can execute with the name 'modmesh'.

If the only entry point to use modmesh, is the viewer, then imho it's the most user-friendly name.

No, it should also be allowed to launch modmesh from a standard Python interpreter, with or without Qt support.

If it's not, then what do you think about 'modmesh-gui'?

I don't like it. *-gui does not sound right to me. But if you can show me a cool application that is named like that, I can reevaluate.


Did I mention it to you before?

@yungyuc Nope, but it's straightforward.

I can't say you are wrong.

"Create 3 meshes in Mesh"

@yungyuc I don't think it's an issue, though. Many projects are using super simple words as well.

You convinced me. It does not read ambiguously when I read it again.

And I have a question, how can I use modmesh without viewer?

@Tucchhaa modmesh can function as a library. See how the pytests and gtests work.

In addition, all GUI code is in modmesh.viewer. If you set BUILD_QT cmake option off, no Qt code is built.

Part of modmesh C++ code can be built standalone, e.g., the buffer: contrib/standalone_buffer/Makefile. It is exercised in Github Actions.

I can execute with the name 'modmesh'.

@Tucchhaa modmesh is just a temporary name, we will give the project an official name later.

Overall, I propose that the GUI be called "Mesh", and the library be called "modmesh" (maybe "libmesh" or "pymesh" is better).

But Mesh has another issue. We currently use "viewer" as the binary name and the sub-module name (modmesh.viewer). After using a new name for the binary, it should also be used as the sub-module name. Then modmesh.mesh is confusing:

from modmesh import mesh
# It does not look like something for GUI.
mesh.run()

@tigercosmos
Copy link
Collaborator

But Mesh has another issue. We currently use "viewer" as the binary name and the sub-module name (modmesh.viewer). After using a new name for the binary, it should also be used as the sub-module name. Then modmesh.mesh is confusing:

We might want to reconsider how the project is organized. It seems odd to me that a GUI app is placed within a module library, as it's typically the other way around.

@yungyuc
Copy link
Member Author

yungyuc commented Sep 3, 2024

But Mesh has another issue. We currently use "viewer" as the binary name and the sub-module name (modmesh.viewer). After using a new name for the binary, it should also be used as the sub-module name. Then modmesh.mesh is confusing:

We might want to reconsider how the project is organized. It seems odd to me that a GUI app is placed within a module library, as it's typically the other way around.

Please create a separate thread for discussing the code organization. In this issue, we can focus on naming.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
viewer Visualize stuff
Projects
Status: Todo
Development

No branches or pull requests

3 participants