You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
parcels_contributions houses kernels and code snippets that may be useful to the wider community, however a lot of the context around these is lost (what parcels version was used? where is the original project? links to publication?). After talking with @erikvansebille , we think it would be better to have a page in the comminuty section of the documentation where we actually just link to the different repos. This reduces our maintenance burden while improving the context (and the attribution is cleaner).
I propose the page to be of the format.
# Community Code Showcase
This page collates together links to scripts where Parcels has been used. It acts
as a source of inspiration so users can see how other researchers have set up their
experiments to model their phenomena of interest.
All contributions to this page are welcome. Requirements are that (a) the code is public
and hosted on GitHub/Bitbucket, and (b) there is sufficient context surrounding the code
(e.g., any of: comments in the code, linked publication, a README). It's also highly
preferable that the version of Parcels used is also documented.
Note that the emphasis is not on the analysis of the particle output, but more on the simulation setup.
For analysis, see the [Lagrangian Diags](https://lagrangian-diags.readthedocs.io/en/latest/) project.
## Section 1[title](link)## Section 2
...
In terms of what the section names should be, it would be great to have suggestions.
This also opens the discussion for what the purpose of parcels_contributions should be. Once we set up this page, I think we can remove the kernels from that repo. There is additional content at the wiki that I'm not sure what to do with.
The text was updated successfully, but these errors were encountered:
Nice idea @VeckoTheGecko. To add my 2c, I think you could split this into two categories. The first being "Software that uses Parcels", e.g. plasticparcels, LOCATE, pyPlume, etc. The second being "Research/Other contributions", such as the some of the kernel development with links to doi's of papers that use them, and some of the example plotting, etc.
parcels_contributions
houses kernels and code snippets that may be useful to the wider community, however a lot of the context around these is lost (what parcels version was used? where is the original project? links to publication?). After talking with @erikvansebille , we think it would be better to have a page in the comminuty section of the documentation where we actually just link to the different repos. This reduces our maintenance burden while improving the context (and the attribution is cleaner).I propose the page to be of the format.
In terms of what the section names should be, it would be great to have suggestions.
This also opens the discussion for what the purpose of
parcels_contributions
should be. Once we set up this page, I think we can remove the kernels from that repo. There is additional content at the wiki that I'm not sure what to do with.The text was updated successfully, but these errors were encountered: