Skip to content

Commit e47a67b

Browse files
Update community page (#2538)
* MAINT: Update `make clean` Some jupyter cache results were being saved here causing desync * Update community page * Move lagrangian diagnostics * Update reference * typo * Add "projects that use Parcels" section * copy edit * copy edits * Disable left sidebar * Revert "Disable left sidebar" This reverts commit f624c0a. * Convert cards to list * update link
1 parent f8428ce commit e47a67b

File tree

3 files changed

+34
-39
lines changed

3 files changed

+34
-39
lines changed

docs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ help:
5050

5151
clean:
5252
rm -rf $(BUILDDIR)/*
53+
rm -rf .jupyter_cache
5354

5455
html:
5556
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

docs/community/index.md

Lines changed: 32 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,5 @@
11
# Community
22

3-
```{toctree}
4-
:caption: CLAM Community
5-
:maxdepth: 1
6-
:hidden:
7-
8-
Website <https://clam-community.github.io/>
9-
```
10-
11-
```{toctree}
12-
:caption: GitHub
13-
:maxdepth: 1
14-
:hidden:
15-
16-
Discussions <https://github.com/Parcels-code/parcels/discussions>
17-
Issues <https://github.com/Parcels-code/parcels/issues>
18-
```
19-
20-
```{toctree}
21-
:caption: Community examples
22-
:maxdepth: 1
23-
:hidden:
24-
25-
Repository <https://github.com/Parcels-code/parcels_contributions>
26-
```
27-
283
Parcels users and developers interact in a vibrant community on a few different platforms. Check out the cards below to see how you can interact with us.
294

305
`````{grid} 1 2 2 2
@@ -78,6 +53,10 @@ Report a bug with an Issue
7853
7954
Curious to see if someone has already written the custom `Kernel` you are thinking of or runs **Parcels** with the same hydrodynamic data? Check out the parcels_contributions repository and share examples with other users!
8055
56+
```{image} https://img.shields.io/badge/maintainer_needed-red
57+
:width: 40%
58+
```
59+
8160
+++
8261
8362
```{button-link} https://github.com/Parcels-code/parcels_contributions
@@ -88,20 +67,35 @@ Curious to see if someone has already written the custom `Kernel` you are thinki
8867
Share custom Parcels code
8968
```
9069
````
91-
````{grid-item-card} Lagrangian Diagnostics
92-
:img-top: ../_static/LAdiag-logo.svg
93-
:shadow: md
70+
`````
9471

95-
Are you interested in advanced analysis and diagnostics of Parcels output or Lagrangian trajectories in general? The Lagrangian Diagnostics project provides code and descriptions of different analyses.
72+
(analysis-code)=
9673

97-
+++
74+
## Analysis code
9875

99-
```{button-link} https://lagrangian-diags.readthedocs.io/en/latest/
100-
:click-parent:
101-
:color: secondary
102-
:expand:
76+
The following is an alphabetically sorted list of tools for analysing Lagrangian trajectory output:
10377

104-
Visit Lagrangian Diagnostics
105-
```
106-
````
107-
`````
78+
- [Lagrangian Diagnostics](https://lagrangian-diags.readthedocs.io/en/latest/) (![maintainer needed](https://img.shields.io/badge/maintainer_needed-red)): Are you interested in advanced analysis and diagnostics of Parcels output or Lagrangian trajectories in general? The Lagrangian Diagnostics project provides code and descriptions of different analyses.
79+
- [Lagrangian Trajectories Toolbox](https://github.com/oj-tooth/lt_toolbox): A Python library dedicated to the post-processing, visualisation and analysis of Lagrangian particle trajectories. This library assumes trajectories are stored as tabular output (e..g, Parquet or CSV).
80+
- [TrajAn](https://github.com/OpenDrift/trajan): A Python package for analysing and plotting ocean drifter and trajectory data stored, developed as part of the OpenDrift project. This library assumes trajectories are stored as CF-compliant Netcdf/Zarr output.
81+
82+
## Projects that use Parcels
83+
84+
The following is an alphabetically sorted list of projects that use Parcels:
85+
86+
- [LOCATE](https://github.com/UPC-LOCATE/LOCATE/): A collection of numerical tools developed within LOCATE ESA-funded project to build simulations of plastic particle dispersion in nearshore water.
87+
- [PlasticParcels](https://github.com/Parcels-code/plasticparcels): A tool - based on Parcels - providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.
88+
- [pyPlume](https://github.com/jerukan/PyPlume): A collection of notebooks and methods made unifying the process of loading two-dimensional oceanic current vector fields from models and observations, simulating trajectory models, and analyzing and visualizing particle trajectories.
89+
- [VirtualFleet](https://github.com/euroargodev/VirtualFleet): Make and analyse simulations of virtual Argo float trajectories
90+
- [VirtualShip](https://virtualship.parcels-code.org/): A framework to plan and conduct a virtual research expedition, receiving measurements as if they were coming from actual oceanographic instruments.
91+
92+
## Other Lagrangian software
93+
94+
The following is an alphabetically sorted list of other Lagrangian ocean modelling and analysis software:
95+
96+
- [connectivity-modeling-system (CMS)](https://github.com/beatrixparis/connectivity-modeling-system)
97+
- [Drifters.jl](https://github.com/JuliaClimate/Drifters.jl)
98+
- [oceantracker](https://github.com/oceantracker/oceantracker)
99+
- [OpenDrift](https://github.com/OpenDrift/opendrift)
100+
- [TrackMPD](https://github.com/IJalonRojas/TrackMPD)
101+
- [TRACMASS](https://www.tracmass.org/)

docs/getting_started/explanation_concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ pset.execute(kernels=kernels, dt=dt, runtime=runtime)
188188

189189
To analyse the particle data generated in the simulation, we need to define a `parcels.ParticleFile` and add it as an argument to `parcels.ParticleSet.execute()`. The output will be written in a [zarr format](https://zarr.readthedocs.io/en/stable/), which can be opened as an `xarray.Dataset`. The dataset will contain the particle data with at least `time`, `z`, `lat` and `lon`, for each particle at timesteps defined by the `outputdt` argument.
190190

191-
There are many ways to analyze particle output, and although we provide [a short tutorial to get started](./tutorial_output.ipynb), we recommend writing your own analysis code and checking out other projects such as [trajan](https://opendrift.github.io/trajan/index.html) and [Lagrangian Diagnostics](https://lagrangian-diags.readthedocs.io/en/latest/).
191+
There are many ways to analyze particle output, and although we provide [a short tutorial to get started](./tutorial_output.ipynb), we recommend writing your own analysis code and checking out [related Lagrangian analysis projects in our community page](../community/index.md#analysis-code).
192192

193193
```{admonition} 🖥️ Learn how to run a simulation
194194
:class: seealso

0 commit comments

Comments
 (0)