A python package that interpolates data from ocean dataset from both Eulerian and Lagrangian perspective.
Project description
seaduck
A python package that interpolates data from ocean dataset from both Eulerian and Lagrangian perspective.
Quick Start
>>> import seaduck as sd
Documentation
Seaduck documentation: https://macekuailv.github.io/seaduck/
Citation
Please cite our paper on the Journal of Open Source Software
Jiang et al., (2023). Seaduck: A python package for Eulerian and Lagrangian interpolation on ocean datasets. Journal of Open Source Software, 8(92), 5967, https://doi.org/10.21105/joss.05967
Workflow for developers/contributors
For best experience create a new conda environment (e.g. bubblebath):
conda create -n bubblebath
conda activate bubblebath
Before pushing to GitHub, run the following commands:
- Update conda environment:
make conda-env-update
- Install this package:
pip install -e .
- Run quality assurance checks:
make qa
- Run tests:
make unit-tests
- Run the static type checker:
make type-check
- Build the documentation:
make docs-build
- Build the pdf version of the paper
make joss
License
Copyright 2023, Wenrui Jiang.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.