OceanParcels / plasticparcels

Repository for PlasticParcels tool
MIT License
3 stars 1 forks source link

Improving the readthedocs documentation #33

Closed michaeldenes closed 1 month ago

michaeldenes commented 1 month ago

This PR is to improve the documentation of plasticparcels. Currently a lot of information is missing, specifically the required datasets, and some information on the kernels and initialisation maps.

codecov-commenter commented 1 month ago

Codecov Report

Attention: Patch coverage is 0% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 15.43%. Comparing base (7664fd0) to head (fff5309).

Files Patch % Lines
plasticparcels/constructors.py 0.00% 14 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #33 +/- ## ======================================= Coverage 15.43% 15.43% ======================================= Files 6 6 Lines 473 473 ======================================= Hits 73 73 Misses 400 400 ``` | [Flag](https://app.codecov.io/gh/OceanParcels/plasticparcels/pull/33/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OceanParcels) | Coverage Δ | | |---|---|---| | [unit-tests](https://app.codecov.io/gh/OceanParcels/plasticparcels/pull/33/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OceanParcels) | `15.43% <0.00%> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OceanParcels#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

michaeldenes commented 1 month ago

@erikvansebille , the paper is now in a final draft form (downloadable via the actions tab above).

The only things I can think of are: a) should we include more references for the line '... users can perform Lagrangian simulations of a wide variety of particulates, such as tuna, plastic, plankton, icebergs, turtles...'? b) can we remove some of the code in the usage example, and just link to the tutorial and show the plots?

EDIT: and c) dealing with the Copernicus Marine Service reference, what should we reference here?

michaeldenes commented 1 month ago

@erikvansebille a last double check review before we release a new version and submit?

erikvansebille commented 1 month ago

@erikvansebille a last double check review before we release a new version and submit?

Yep, I'll check now