Skip to content

Conversation

@VeckoTheGecko
Copy link
Collaborator

This PR updates the installation of Parcels in VirtualShip to be a source installation using Pixi as well as a git submodule. This git submodule approach means that you can edit Parcels alongside virtualship and easily push changes back to Parcels as well.

This is the resulting tree:

.
├── Parcels
│   ├── CITATION.cff
│   ├── codecov.yml
│   ├── docs
│   ├── LICENSE.md
│   ├── licenses
│   ├── pixi.toml
│   ├── pyproject.toml
│   ├── README.md
│   ├── src
│   |   └── parcels
│   ├── tests
│   └── tests-v3
├── pixi.lock
├── pixi.toml
├── pyproject.toml
├── README.md
├── src
|   └── virtualship
...

Making edits to Parcels via the submodule

  • Follow updated contributing instructions
  • cd into Parcels
  • Doing git status you'll see the status of the Parcels repo. Make any edits you need, making branches and pushing to Parcels
  • Run any tests needed (either in Parcels or in virtualship folder)
  • PR via Parcels

Once merged you can fetch the updated v4-dev branch in the submodule


This PR:

Note that a lot of the changes in here regarding Pixi (except the source installation part) are changes that we want to incorporate into v1-dev of parcels as its a significant improvement on previous dev workflow. These are in the pixi branch, or can be cherrypicked from here.

  • Closes None- Define workspace with VirtualShip name and pixi-build preview
  • Configure multiple test environments (py310, py311, py312)
  • Set up feature environments for docs, typing, and pre-commit
  • Define pixi tasks for tests, docs, linting, and type checking
  • Align dependencies with existing pyproject.toml

VeckoTheGecko and others added 11 commits October 23, 2025 09:12
- Define workspace with VirtualShip name and pixi-build preview
- Configure multiple test environments (py310, py311, py312)
- Set up feature environments for docs, typing, and pre-commit
- Define pixi tasks for tests, docs, linting, and type checking
- Align dependencies with existing pyproject.toml
- Replace mamba-org/setup-micromamba with prefix-dev/setup-pixi
- Update test job to use pixi environments (test-py310, test-py312)
- Update typechecking job to use pixi run typing
- Enable pixi caching for faster CI runs
- Simplify workflow by removing manual dependency installation
- Replace Conda-based development setup with Pixi
- Add comprehensive Pixi workflows section with examples
- Document testing, docs, and code quality commands
- Include tips for environment management and CI reproduction
- Update dependency management instructions to reference pixi.toml
Add Pixi badge to indicate project uses Pixi for environment management
Environment management is now handled by pixi.toml. The environment.yml
file is no longer needed as all dependencies are defined in pixi.toml.
@VeckoTheGecko VeckoTheGecko added the edito-hackathon Items related to the edito-hackathon label Oct 23, 2025
@VeckoTheGecko VeckoTheGecko force-pushed the pixi-for-edito branch 2 times, most recently from 228c044 to 31c7bbb Compare October 23, 2025 09:08
@VeckoTheGecko

This comment was marked as outdated.

@VeckoTheGecko VeckoTheGecko merged commit 7204e25 into Parcels-code:edito-hackathon Oct 23, 2025
9 of 12 checks passed
@VeckoTheGecko VeckoTheGecko deleted the pixi-for-edito branch October 23, 2025 09:09
@VeckoTheGecko

This comment was marked as outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

edito-hackathon Items related to the edito-hackathon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant