Improving the readthedocs documentation #33
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #33 +/- ##
=======================================
Coverage 15.43% 15.43%
=======================================
Files 6 6
Lines 473 473
=======================================
Hits 73 73
Misses 400 400
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
…update the .json settings files to include their own data directories.
…s.png figure, changes to the wording in schematic.png figure, and a usage example (to complete once changes to the initialisation maps are completed.
docs/paper/paper.md
Outdated
|
|
||
| # Usage Examples | ||
| **TODO fill this in once created** | ||
| # Usage Example | ||
| The `PlasticParcels` github repository provides several useful tutorials. Here, we briefly demonstrate how `PlasticParcels` can be used for a microplastic dispersal simulation in the Mediterranean Sea. The tutorial can be found on the `PlasticParcels` github repository, ... |
There was a problem hiding this comment.
This still needs to be done?
There was a problem hiding this comment.
Yeah, I can create this very quickly if we decide to use the one particle per cell approach that is currently implemented. However, we wanted to do this with n particles per grid cell.
I've now created a script that saves the IDs of the grid cell, so that we can randomly distribute particles across a grid cell. The non-trivial part is how to deal with the curvilinear grid.
I think we can distribute on a [0,1]x[0,1] square, and rotate it like we do with the whole Jacobian approach. I just need to figure out how to do that rotation. Then I can run the example and update the plots.
What do you think?
There was a problem hiding this comment.
I've now included a usage example in the docs/paper/paper.md file
…nitialisation maps (for use in the paper)
|
@erikvansebille , the paper is now in a final draft form (downloadable via the actions tab above). The only things I can think of are: EDIT: and c) dealing with the Copernicus Marine Service reference, what should we reference here? |
…s 'Sebille, E. van.'
…in the concentration plot in the Italy coastline example.
There was a problem hiding this comment.
I added three comments to the paper.md and schematic.png, and also created a PR (#35) with textual and grammar changes/suggestions
Some textual/grammar suggestions to the manuscript
…with parcels style
…o be inline with parcels style
…e name changes, also cleaned up the final plotting code
|
@erikvansebille a last double check review before we release a new version and submit? |
Yep, I'll check now |
Co-authored-by: Erik van Sebille <[email protected]>
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.