Parcels

Parcels v3.1.0 implements support for CROCO sigma grids, adds reprs for key parcels classes (allowing you to easily introspect fieldsets etc), and makes changes to the API (complete with user warnings) to clearly distinguish what the user is expected to use.

What's Changed

Important

* Add Parcels versioning/deprecation policies and maintainer docs by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1696
* Support for CROCO 3D velocities by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1641
* API changes: `Field` and `FieldSet` by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1709
* API changes: `particlefile.py` and other touchups by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1727
* API changes: `particleset.py` and `grid.py` by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1713
* New and updated reprs for Variable, ParticleFile, Field, VectorField, and ParticleSet by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1743

Other

* Patch pypi release python version by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1692
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/OceanParcels/Parcels/pull/1654
* Enable pyupgrade, add Grid repr, and other changes by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1680
* Update the Analytical Advection tutorial by michaeldenes in https://github.com/OceanParcels/Parcels/pull/1703
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/OceanParcels/Parcels/pull/1707
* Test suite tooling by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1704
* Adding explicit explanation how to add tracers in FieldSet.from_nemo() by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1702
* Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.2 by dependabot in https://github.com/OceanParcels/Parcels/pull/1718
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/OceanParcels/Parcels/pull/1714
* Fixing bug in backward-in-time-writing by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1723
* DOC: Separate out linkcheck by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1725
* Update Git archive config by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1717
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/OceanParcels/Parcels/pull/1726
* FieldSet.from_croco vertical velocities warning by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1732
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/OceanParcels/Parcels/pull/1735
* Fixing loaded_time_indices to support more advanced compute() functions by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1733
* Documenting use of interp_method freeslip for B-grids by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1740
* Adding warning particlestartime outputdt multiple by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1739
* Refactors and bugfixes by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1736
* Bugfix warn_outputdt_release_desync for NaN release times by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1744


**Full Changelog**: https://github.com/OceanParcels/Parcels/compare/v3.0.5...v3.1.0

Parcels v3.0.6 is a minor update to v3.0.5 that fixes a bug flagged in 1722 regarding time-stepping in the output file.

**Full Changelog**: https://github.com/OceanParcels/Parcels/compare/v3.0.5...v3.0.6

Parcels v3.0.5 is a minor update to [v3.0.4](https://github.com/OceanParcels/Parcels/releases/tag/v3.0.4) that fixes a few minor bugs, cleans up code and adds contribution guidelines.

Most important changes
* Implement warnings in Parcels by andrew-s28 in https://github.com/OceanParcels/Parcels/pull/1672
* Type annotations by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1660
* added: FieldSet.from_a_grid_dataset by KOMPALALOKESH in https://github.com/OceanParcels/Parcels/pull/1650
* Drop Python 3.8, 3.9 support by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1658
* Support use of parcels.rng in Kernels by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1618 and update import statements https://github.com/OceanParcels/Parcels/pull/1610
* Fix bug in JIT when interpolation overrides error of previous interpolation by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1645

Other minor changes
* Add deprecation decorators by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1683
* Updates properties for xarray API change by andrew-s28 in https://github.com/OceanParcels/Parcels/pull/1596
* Fixing customed_Cfunc_header_test to use particle_dlon by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1606
* Documentation updates and numpy randint bugfix by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1604
* Fixing bug when executing a breaking pset by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1630

Documentation updates
* Contributing documentation and issue/discussion templates changes by VeckoTheGecko in https://github.com/OceanParcels/Parcels/pull/1634
* Minor tutorial updates by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1633
* Updating docstrings for advection kernels by erikvansebille in https://github.com/OceanParcels/Parcels/pull/1640

Code quality improvement
* https://github.com/OceanParcels/Parcels/pull/1603, https://github.com/OceanParcels/Parcels/pull/1605, https://github.com/OceanParcels/Parcels/pull/1614, https://github.com/OceanParcels/Parcels/pull/1615, https://github.com/OceanParcels/Parcels/pull/1635, https://github.com/OceanParcels/Parcels/pull/1638, https://github.com/OceanParcels/Parcels/pull/1644, https://github.com/OceanParcels/Parcels/pull/1648, https://github.com/OceanParcels/Parcels/pull/1652, https://github.com/OceanParcels/Parcels/pull/1655, https://github.com/OceanParcels/Parcels/pull/1666, https://github.com/OceanParcels/Parcels/pull/1667


New Contributors
* KOMPALALOKESH made their first contribution in https://github.com/OceanParcels/Parcels/pull/1650
* dependabot made their first contribution in https://github.com/OceanParcels/Parcels/pull/1677

**Full Changelog**: https://github.com/OceanParcels/Parcels/compare/v3.0.4...v3.0.5

Most important changes
* Changing np.infty to np.inf for compatibility with NumPy 2.0 by andrew-s28 in https://github.com/OceanParcels/parcels/pull/1589
* Note in the Parcels structure tutorial on the `field[particle]` sampling speed by erikvansebille in https://github.com/OceanParcels/parcels/pull/1577

Other minor changes
* Fixing some AST deprecationwarnings by erikvansebille in https://github.com/OceanParcels/parcels/pull/1575
* Fix minor spelling grammar tutorials by michaeldenes in https://github.com/OceanParcels/parcels/pull/1582
* Renaming CMEMS to Copernicus Marine Service and CMS in documentation by erikvansebille in https://github.com/OceanParcels/parcels/pull/1583

New Contributors
* michaeldenes made their first contribution in https://github.com/OceanParcels/parcels/pull/1582

**Full Changelog**: https://github.com/OceanParcels/parcels/compare/v3.0.3...v3.0.4

Parcels v3.0.3 is a minor update to [v3.0.2](https://github.com/OceanParcels/parcels/releases/tag/v3.0.2). It includes [a new way to create a FieldSet using `FieldSet.from_modulefile()`](https://github.com/OceanParcels/parcels/pull/1566), [improves the implementation of the `AdvectionRK45` Kernel](https://github.com/OceanParcels/parcels/pull/1539), and [implements a test for the `pypi`-package upon release](https://github.com/OceanParcels/parcels/pull/1574). It also includes a number of updates to the tutorials and fixes a number of bugs.

What's Changed

Most relevant for users
* Creating a new `Fieldset.from_modulefile()` method by erikvansebille in https://github.com/OceanParcels/parcels/pull/1566
* Improve AdvectionRK45 Kernel implementation by erikvansebille in https://github.com/OceanParcels/parcels/pull/1539
* PyPi release updates by andrew-s28 in https://github.com/OceanParcels/parcels/pull/1574

Documentation improvements
* Adding note to Parcels tutorial on add_variable compatibility by erikvansebille in https://github.com/OceanParcels/parcels/pull/1505
* Moving the note on add_variables in the Parcels tutorial to its first use by erikvansebille in https://github.com/OceanParcels/parcels/pull/1506
* Explaining statuscode kernel order by erikvansebille in https://github.com/OceanParcels/parcels/pull/1508
* Updating Argo kernel to parcels v3 API by erikvansebille in https://github.com/OceanParcels/parcels/pull/1524
* Adding infobox on UnitConverter to sampling tutorial by erikvansebille in https://github.com/OceanParcels/parcels/pull/1540
* Fixing weblink to Ariane software page by erikvansebille in https://github.com/OceanParcels/parcels/pull/1543
* Adding section in parcels structure tutorial on optimisation and parallelisation by erikvansebille in https://github.com/OceanParcels/parcels/pull/1555
* Clarifying particle_dlon variable use in kernel loop tutorial by erikvansebille in https://github.com/OceanParcels/parcels/pull/1535
* Simplifying parcels structure note by erikvansebille in https://github.com/OceanParcels/parcels/pull/1556
* Fixing link to partition function in the parcels structure tutorial by erikvansebille in https://github.com/OceanParcels/parcels/pull/1572

Bug-fixes and code-cleaning etc
* Update particleset.py by dicaearchus in https://github.com/OceanParcels/parcels/pull/1547
* Adding support for delete_cfiles as pset.execute() keyword by erikvansebille in https://github.com/OceanParcels/parcels/pull/1551
* Compilation error message fix for local variable name that is also FieldSet constant by erikvansebille in https://github.com/OceanParcels/parcels/pull/1552
* Pinning zarr in environment files to !=2.18.0 by erikvansebille in https://github.com/OceanParcels/parcels/pull/1565 and jamespolly in https://github.com/OceanParcels/parcels/pull/1567
* Throwing an error when dt has too high precision by erikvansebille in https://github.com/OceanParcels/parcels/pull/1558

New Contributors
* jamespolly made their first contribution in https://github.com/OceanParcels/parcels/pull/1567
* andrew-s28 made their first contribution in https://github.com/OceanParcels/parcels/pull/1574

**Full Changelog**: https://github.com/OceanParcels/parcels/compare/v3.0.2...v3.0.3

Parcels v3.0.2 is a minor update to [v3.0.1](https://github.com/OceanParcels/parcels/releases/tag/v3.0.1). It includes a new, more intuitive way to add `Variables` to a `ParticleSet` class, using a new `Particleset.add_variable()` method (#1501). It also fixes a number of bugs.

What's Changed

Most relevant for users
* Implementing `Particleset.add_variable()` method by erikvansebille in https://github.com/OceanParcels/parcels/pull/1501
* Setting defaults for `FieldSet.computeTimeChunk()` by erikvansebille in https://github.com/OceanParcels/parcels/pull/1502

Bug-fixes and code cleaning etc
* make it possible to import dataset with single time instance by dicaearchus in https://github.com/OceanParcels/parcels/pull/1496
* Simplifying the NEMO curvilinear tutorial by erikvansebille in https://github.com/OceanParcels/parcels/pull/1499
* Bugfix for cgrid eval without applyConversion by erikvansebille in https://github.com/OceanParcels/parcels/pull/1500
* [pre-commit.ci] pre-commit autoupdate by pre-commit-ci in https://github.com/OceanParcels/parcels/pull/1490


**Full Changelog**: https://github.com/OceanParcels/parcels/compare/v3.0.1...v3.0.2