search

simonsobs / sisock

Sisock ('saɪsɒk): streaming of Simons Obs. data over websockets for quicklook
Other
2 stars 0 forks source link

Naming Conventions and the Librarian #32

Open ahincks opened 5 years ago

ahincks commented 5 years ago

The terminology "data node server" comes from the alpenhorn file tracker. Since we are going to be using the HERA Librarian, I would suggest that we use nomenclature that is more inline with this software.

BrianJKoopman commented 5 years ago

Interesting. Any idea the terminology used in the Librarian?

I'd also be fine coming up with our own suitable terms. I would like to settle on something soon though. I've been prefixing the docker image names with 'dans' for DAta Node Server (avoiding any possible confusion with DNS as an acronym.)

ahincks commented 5 years ago

I've had a look through the slides Paul La Plante posted on the DAQ agenda (16/05/2019) and I don't believe there is an analogous concept to a data node server in the Librarian. Perhaps the closest is "store". So perhaps there isn't an obvious nomenclature change.

Are you happy enough with "dans"? We could just keep it, unless you find it a non-intuitive term. (One possibility would be to shorten it to "data server".)

BrianJKoopman commented 5 years ago

I like the idea of shortening "data node server". I'd be happy with even just "server". If that's too short, I'm also happier with "data server".

Once we agree on something I'll probably move components/data_node_servers/ to whatever is appropriate.

ahincks commented 5 years ago

I prefer "data server" to "server" because the latter is too generic. Data servers can be distinguished from other "servers", such as grafana_server.

If you agree, feel free to go ahead and make the change. The README.md should also be changed (including the diagram), but I can take care of that if you don't get around to it.

BrianJKoopman commented 5 years ago

Alright, "data server" it is. I've started changing over to the new name. "node" is used in several places in the code though. I've done all the documentation bits, will work on the function/variable names soon.

Working here: https://github.com/simonsobs/sisock/tree/data-server-rename