hs_restclient citation

[amabdallah]

What's the best way to cite hs_restclient in my paper? It would be useful if you include the preferred citation at the bottom of the ReadME file. I'd appreciate a quick response as I'm submitting my paper very soon and I want to credit hs_restclient. Thanks Adel

[dtarb]

Winging it a bit here, but I would suggest treat is as a website HydroShare Development Team, 2020, "Python-based client library for HydroShare REST API", https://github.com/hydroshare/hs_restclient, accessed 12/30/20.

Recognizing that the software will be updated, if precise citation of the version you used is needed for reproducibility you could use something like HydroShare Development Team, 2020, "Python-based client library for HydroShare REST API", Release 1.3.6, https://github.com/hydroshare/hs_restclient/releases/tag/1.3.6, accessed 12/30/20.

The suggestion to include this in Readme is good. Before doing so I'd prefer a bit more investigation as to whether the above suggestions are good or whether there are better alternatives. If you dig in to this and decide on a preferred alternative you are welcome to fork, update the readme and make a pull request to get this done.

[danames]

Adel, where appropriate, you could also cite other papers that make use of and/or describe the use of hs_restclient ( https://scholar.google.com/scholar?as_ylo=2016&q=hs_restclient&hl=en&as_sdt=0,45).

• Dan

  ---

  Daniel P. Ames, Ph.D., P.E. Professor, Civil & Environmental Engineering,Brigham Young University, Provo, Utah, USA Past-President, International Environmental Modelling & Software Society Editor-in-Chief, Environmental Modelling & Software https://ceen.byu.edu/directory/dan-p-ames http://ceen.et.byu.edu/content/dan-ames http://www.researchgate.net/profile/Daniel_Ames http://scholar.google.com/citations?user=S0GUCeUAAAAJ

---

On Wed, Dec 30, 2020 at 1:38 PM David Tarboton notifications@github.com wrote:

Winging it a bit here, but I would suggest treat is as a website HydroShare Development Team, 2020, "Python-based client library for HydroShare REST API", https://github.com/hydroshare/hs_restclient, accessed 12/30/20.

Recognizing that the software will be updated, if precise citation of the version you used is needed for reproducibility you could use something like HydroShare Development Team, 2020, "Python-based client library for HydroShare REST API", Release 1.3.6, https://github.com/hydroshare/hs_restclient/releases/tag/1.3.6, accessed 12/30/20.

The suggestion to include this in Readme is good. Before doing so I'd prefer a bit more investigation as to whether the above suggestions are good or whether there are better alternatives. If you dig in to this and decide on a preferred alternative you are welcome to fork, update the readme and make a pull request to get this done.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/hydroshare/hs_restclient/issues/125#issuecomment-752751007, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA2PZ5FMK3O3IMTNTIRSPHLSXOFT7ANCNFSM4VOVRTIQ .

[amabdallah]

Thanks, David and Dan for the prompt response. I'll use the second citation for now and cite Tian Gan's paper on this as well.

Here are my thoughts as part of the discussion on this

• Having the author as "HydroShare Development Team" makes it easier for now but I'd argue that having all the names who contributed to the client is better. It's not uncommon that journal papers may include a dozen of authors so it should be fine to list all the names on this repo. Let's give them credit.

• EndNote has a "Web Page" reference type but I'd argue that software/code on GitHub is beyond a web page especially given the releases (snapshots) that a repo contains. The other close reference type is "Computer Program" which probably fits better as it has "Version" that fits with a release.

In the end, having a download button that can take care of the citation format for the users would be great!