Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions .github/ci/recipe.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Recipe for https://github.com/prefix-dev/rattler-build used for nightly releases of Parcels
# during version 4 alpha development
#
# Adapted from the conda forge recipe
context:
name: parcels
version: 4.0.0alpha0 # The last number here needs to be bumped for each new alpha release

package:
name: ${{ name|lower }}
version: ${{ version }}

source:
path: ../..

build:
number: 0
noarch: python
script:
- python -m pip install . -vv --no-deps --no-build-isolation

requirements:
host:
- python 3.11.*
- pip
- setuptools
- setuptools_scm
- setuptools_scm_git_archive
- wheel
run:
- python >=3.11
- cftime
- dask
- matplotlib-base >=2.0.2
- netcdf4 >=1.1.9
- numpy >=1.11
- platformdirs
- psutil
- pymbolic
- pytest
- scipy >=0.16.0
- trajan
- tqdm
- xarray >=0.10.8
- zarr >=2.11.0,!=2.18.0,<3
- uxarray>=2025.3.0
- pyogrio # needed for geopandas (uxarray -> geoviews -> geopandas -> pyogrio, but for some reason conda doesn't pick it up automatically)
- pooch

tests:
- python:
imports:
- parcels

about:
homepage: https://github.com/OceanParcels/parcels
license: MIT
license_file: LICENSE.md
summary: Probably A Really Computationally Efficient Lagrangian Simulator
description: |
Parcels (Probably A Really Computationally Efficient Lagrangian Simulator)
is a set of Python classes and methods to create customisable particle
tracking simulations using output from Ocean Circulation models.
Parcels can be used to track passive and active particulates such as
water, nutrients, plankton, plastic and fish.
documentation: https://oceanparcels.org/
repository: https://github.com/OceanParcels/parcels

extra:
recipe-maintainers:
- VeckoTheGecko
28 changes: 28 additions & 0 deletions .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
on:
workflow_dispatch:

permissions:
contents: read
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build conda package
uses: prefix-dev/[email protected]
with:
recipe-path: .github/ci/recipe.yaml

- name: Upload all packages
shell: bash
run: |
shopt -s nullglob
EXIT_CODE=0
for pkg in $(find output -type f \( -name "*.conda" -o -name "*.tar.bz2" \) ); do
if ! rattler-build upload prefix -c parcels "${pkg}"; then
EXIT_CODE=1
fi
done
exit $EXIT_CODE
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
build/*
docs/_build/*
docs/_downloads
output

*.log
*.nc
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Collaboration on v4 development is happening on the [Parcels v4 Project Board](h
The pages below provide further background on the development of Parcels v4. You can think of this page as a "living" document as we work towards the release of v4.

```{toctree}

install
api
nojit
TODO
Expand Down
21 changes: 21 additions & 0 deletions docs/v4/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Install an alpha version of Parcels v4

````{warning}
Before installing an alpha version of Parcels, we *highly* recommend creating a new environment so that doesn't affect package versions in your current environment (which you may be using for your research).

Do the following to create a new environment:

```sh
conda create -n parcels-v4-alpha python=3.11
conda activate parcels-v4-alpha
```

````

During development of Parcels v4, we are uploading versions of the package to an [index on prefix.dev](https://prefix.dev/channels/parcels/packages/parcels). This allows users to easily install an unreleased version without having to do a [development install](../installation.rst)! Give it a spin!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also mention that users can continue using their v3 version by doing conda activate parcels (or whatever their ‘normal’ environment is called)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Also restructured the page a bit so it flows better

Copy link
Contributor Author

@VeckoTheGecko VeckoTheGecko Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

```sh
conda install -c https://repo.prefix.dev/parcels parcels
```

During the development of Parcels v4 we will be occasionally releasing these alpha package versions so that users can try them out. If you're installing Parcels normally (i.e., via Conda forge) you can continue to do so without disruption.
Loading