[prev in list] [next in list] [prev in thread] [next in thread]
List: grass-user
Subject: Re: [GRASS-user] Example project for a GRASS GIS module on GitHub
From: Vaclav Petras <wenzeslaus () gmail ! com>
Date: 2020-02-05 1:29:26
Message-ID: CABo5uVvGj6fjJC=VpPje5KZuF-+SeiX1bjie1v-FhsEMi4Y=KA () mail ! gmail ! com
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
Zenodo & JOSS in relation to r.example.plus: If you have idea on the text,
please open a PR. I suggest adding it as a subsection of "What is next" and
making the current content of that section a subsection as well.
As for the JOSS and grass-addons repo:
On Tue, Feb 4, 2020 at 8:25 AM Stefan Blumentrath <
Stefan.Blumentrath@nina.no> wrote:
> Hi,
>
> In this context we should probably also keep JOSS in mind and probably
> make devs aware of that possibility, including linking a JOSS paper to the
> repo. See presentation from FOSSDEM [1] for more background.
>
> Question is, if it is possible to have the link on a module basis in
> grass-addons.
What do you mean by a link? Does JOSS require the software to be in a
separate repo?
Best,
Vaclav
> Cause, I also think that getting stuff into grass-addons is important for
> the reasons Vaclav lists in the repo.
>
> Cheers
> Stefan
>
> 1: https://video.fosdem.org/2020/AW1.126/open_research_joss.webm
>
> -----Original Message-----
> From: "Peter Löwe" <peter.loewe@gmx.de>
> Sent: tirsdag 4. februar 2020 11:24
> To: grass-user@lists.osgeo.org
> Cc: Stefan Blumentrath <Stefan.Blumentrath@nina.no>; wenzeslaus@gmail.com
> Subject: [GRASS-user] Example project for a GRASS GIS module on GitHub
>
> Hi Vasek,
>
> thanks for setting up the demo module on GitHub!
>
> To demonstrate how module authors can get credit by scientific citation,
> some kind of reference/howto describing how the integration of the GitHub
> project and the Zenodo data repositiory (https://www.zenodo.org/) can be
> achieved, as explained here:
> https://www.zenodo.org/login/?next=%2Faccount%2Fsettings%2Fgithub%2F
> https://guides.github.com/activities/citable-code/
> By doing so, a persistent identifier (DOI) is assigned to the GRASS module
> codebase. Zenodo also offers a handy tool to provide citation strings for
> the modulde code in hundreds of citation styles.
>
> Best regards,
> Peter
>
> <peter.loewe@gmx.de>
>
> > From: grass-user <grass-user-bounces@lists.osgeo.org> On Behalf Of
> Vaclav Petras
> > Sent: torsdag 30. januar 2020 02:31
> > To: grass-dev@lists.osgeo.org; GRASS user list <
> grass-user@lists.osgeo.org>
> > Subject: [GRASS-user] Example project for a GRASS GIS module on GitHub
> >
> > Dear users and contributors,
> >
> > I've created an example project (repository) on GitHub. It is a GRASS
> GIS module written in Python which simply adds two raster maps together. It
> uses GitHub Actions to build the module and publish its documentation as a
> website (using GitHub Pages).
> >
> > https://github.com/wenzeslaus/r.example.plus
> >
> > This is based on my earlier work on an example project on GitLab [1] and
> includes several improvements and changes:
> >
> > * There is a test suite included with couple of test functions.
> > * It uses Black for code formatting (assuming author runs it manually).
> > * Repository is marked as a template (see the big "Use this template"
> button).
> > * GitHub Actions are used for:
> > * compiling the module and running tests,
> > * checking code quality with Flake8 and Pylint, and
> > * checking code style with Black.
> > * GitHub Actions are now used for publishing documentation (done by
> GitLab CI before).
> > * Option names now follow GRASS GIS standards more.
> > * More documentation in the code and on how to use the code.
> > * Badges are now in the README file (GitLab had those as project
> properties).
> >
> > Otherwise, I hope the project should describe itself and if something is
> missing or is not documented enough, please open an issue or a pull request.
> >
> > Best,
> > Vaclav
> >
> > PS: We can discuss on grass-dev if this should go under some
> organization and how to improve the "what's next" part [2].
> >
> > [1]
> https://lists.osgeo.org/pipermail/grass-dev/2018-November/090438.html
> > [2] https://github.com/wenzeslaus/r.example.plus#what-is-next
>
>
[Attachment #5 (text/html)]
<div dir="ltr"><div dir="ltr">Zenodo & JOSS in relation to r.example.plus: If you \
have idea on the text, please open a PR. I suggest adding it as a subsection of \
"What is next" and making the current content of that section a subsection \
as well.<br></div><div><br></div><div>As for the JOSS and grass-addons \
repo:<br></div><div><br></div><div class="gmail_quote"><div dir="ltr" \
class="gmail_attr">On Tue, Feb 4, 2020 at 8:25 AM Stefan Blumentrath <<a \
href="mailto:Stefan.Blumentrath@nina.no">Stefan.Blumentrath@nina.no</a>> \
wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px \
0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi,<br> <br>
In this context we should probably also keep JOSS in mind and probably make devs \
aware of that possibility, including linking a JOSS paper to the repo. See \
presentation from FOSSDEM [1] for more background.<br> <br>
Question is, if it is possible to have the link on a module basis in \
grass-addons.</blockquote><div><br></div><div>What do you mean by a link? Does JOSS \
require the software to be in a separate \
repo?</div><div><br></div><div>Best,</div><div>Vaclav<br></div><div> \
</div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px \
solid rgb(204,204,204);padding-left:1ex"> Cause, I also think that getting stuff into \
grass-addons is important for the reasons Vaclav lists in the repo.<br> <br>
Cheers<br>
Stefan<br>
<br>
1: <a href="https://video.fosdem.org/2020/AW1.126/open_research_joss.webm" \
rel="noreferrer" target="_blank">https://video.fosdem.org/2020/AW1.126/open_research_joss.webm</a><br>
<br>
-----Original Message-----<br>
From: "Peter Löwe" <<a href="mailto:peter.loewe@gmx.de" \
target="_blank">peter.loewe@gmx.de</a>> <br>
Sent: tirsdag 4. februar 2020 11:24<br>
To: <a href="mailto:grass-user@lists.osgeo.org" \
target="_blank">grass-user@lists.osgeo.org</a><br>
Cc: Stefan Blumentrath <<a href="mailto:Stefan.Blumentrath@nina.no" \
target="_blank">Stefan.Blumentrath@nina.no</a>>; <a \
href="mailto:wenzeslaus@gmail.com" \
target="_blank">wenzeslaus@gmail.com</a><br>
Subject: [GRASS-user] Example project for a GRASS GIS module on GitHub<br>
<br>
Hi Vasek,<br>
<br>
thanks for setting up the demo module on GitHub!<br>
<br>
To demonstrate how module authors can get credit by scientific citation, some kind of \
reference/howto describing how the integration of the GitHub project and the Zenodo \
data repositiory (<a href="https://www.zenodo.org/" rel="noreferrer" \
target="_blank">https://www.zenodo.org/</a>) can be achieved, as explained here: <a \
href="https://www.zenodo.org/login/?next=%2Faccount%2Fsettings%2Fgithub%2F" \
rel="noreferrer" target="_blank">https://www.zenodo.org/login/?next=%2Faccount%2Fsettings%2Fgithub%2F</a> \
<a href="https://guides.github.com/activities/citable-code/" rel="noreferrer" \
target="_blank">https://guides.github.com/activities/citable-code/</a><br> By doing \
so, a persistent identifier (DOI) is assigned to the GRASS module codebase. Zenodo \
also offers a handy tool to provide citation strings for the modulde code in hundreds \
of citation styles.<br> <br>
Best regards,<br>
Peter<br>
<br>
<<a href="mailto:peter.loewe@gmx.de" \
target="_blank">peter.loewe@gmx.de</a>><br> <br>
> From: grass-user <<a href="mailto:grass-user-bounces@lists.osgeo.org" \
target="_blank">grass-user-bounces@lists.osgeo.org</a>> On Behalf Of Vaclav \
Petras<br> > Sent: torsdag 30. januar 2020 02:31<br>
> To: <a href="mailto:grass-dev@lists.osgeo.org" \
target="_blank">grass-dev@lists.osgeo.org</a>; GRASS user list <<a \
href="mailto:grass-user@lists.osgeo.org" \
target="_blank">grass-user@lists.osgeo.org</a>><br> > Subject: [GRASS-user] \
Example project for a GRASS GIS module on GitHub<br> ><br>
> Dear users and contributors,<br>
><br>
> I've created an example project (repository) on GitHub. It is a GRASS GIS \
module written in Python which simply adds two raster maps together. It uses GitHub \
Actions to build the module and publish its documentation as a website (using GitHub \
Pages).<br> ><br>
> <a href="https://github.com/wenzeslaus/r.example.plus" rel="noreferrer" \
target="_blank">https://github.com/wenzeslaus/r.example.plus</a><br> ><br>
> This is based on my earlier work on an example project on GitLab [1] and \
includes several improvements and changes:<br> ><br>
> * There is a test suite included with couple of test functions.<br>
> * It uses Black for code formatting (assuming author runs it manually).<br>
> * Repository is marked as a template (see the big "Use this template" \
button).<br> > * GitHub Actions are used for:<br>
> * compiling the module and running tests,<br>
> * checking code quality with Flake8 and Pylint, and<br>
> * checking code style with Black.<br>
> * GitHub Actions are now used for publishing documentation (done by GitLab CI \
before).<br> > * Option names now follow GRASS GIS standards more.<br>
> * More documentation in the code and on how to use the code.<br>
> * Badges are now in the README file (GitLab had those as project \
properties).<br> ><br>
> Otherwise, I hope the project should describe itself and if something is missing \
or is not documented enough, please open an issue or a pull request.<br> ><br>
> Best,<br>
> Vaclav<br>
><br>
> PS: We can discuss on grass-dev if this should go under some organization and \
how to improve the "what's next" part [2].<br> ><br>
> [1] <a href="https://lists.osgeo.org/pipermail/grass-dev/2018-November/090438.html" \
rel="noreferrer" target="_blank">https://lists.osgeo.org/pipermail/grass-dev/2018-November/090438.html</a><br>
> [2] <a href="https://github.com/wenzeslaus/r.example.plus#what-is-next" \
rel="noreferrer" target="_blank">https://github.com/wenzeslaus/r.example.plus#what-is-next</a><br>
<br>
</blockquote></div></div>
[Attachment #6 (text/plain)]
_______________________________________________
grass-user mailing list
grass-user@lists.osgeo.org
https://lists.osgeo.org/mailman/listinfo/grass-user
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic