Package: clouddrift
CloudDriftCloudDrift is a Python package that accelerates the use of Lagrangian data for atmospheric, oceanic, and climate sciences.
It is funded byNSF EarthCubethrough theEarthCube Capabilities Grant No. 2126413.Read thedocumentationor explore
theJupyter Notebook Examples.Using CloudDriftStart by reading thedocumentation.Example Jupyter notebooks that showcase the library, as well as scripts
to process various Lagrangian datasets, can be found inclouddrift-examples,gdp-get-started,mosaic-get-started, ora demo for the EarthCube community workshop 2023.Contributing and scopeWe welcome contributions from the community.
If you would like to propose an idea for a new feature or contribute your own
implementation, please follow these steps:Open a newissueto discuss your proposal.Once we agree on a general way forward,fork the repositoryandcreate a
new branchfor your contribution.Write your code andtests. Please follow the same style as the rest of the
codebase and ensure that all new functionality is covered by your tests.Open a pull request and request a review.The scope of CloudDrift includes:Working with contiguous ragged-array data; for example, see theclouddrift.raggedmodule.Common scientific analysis of Lagrangian data, oceanographic or otherwise;
for example, see theclouddrift.kinematics,clouddrift.signal, andclouddrift.waveletmodules.Processing existing Lagrangian datasets into a common data structure and format;
for example, see theclouddrift.adapters.mosaicmodule.Making cloud-optimized ragged-array datasets easily accessible; for example,
see theclouddrift.datasetsmodule.If you have an idea that does not fit into the scope of CloudDrift but you think
it should, please open an issue to discuss it.Getting startedInstall CloudDriftYou can install the latest release of CloudDrift usingpiporconda.Latest official release:pip:In your virtual environment, type:pip install clouddriftTo install optional dependencies needed by theclouddrift.plottingmodule,
type:pip install matplotlib cartopyConda:First addconda-forgeto your channels in your Conda configuration (~/.condarc):conda config --add channels conda-forge
conda config --set channel_priority strictthen install CloudDrift:conda install clouddriftTo install optional dependencies needed by theclouddrift.plottingmodule,
type:conda install matplotlib-base cartopyDevelopment branch:If you need the latest development version, you can install it directly from this GitHub repository.pip:In your virtual environment, type:pip install git+https://github.com/cloud-drift/clouddriftConda:conda env create -f environment.ymlwith the environmentfilelocated in the main repository.Run the testsTo run the tests, you need to first download the CloudDrift source code from
GitHub:git clone https://github.com/cloud-drift/clouddrift
cd clouddrift/and create the virtual environment.With pip:python3 -m venv .venv
source .venv/bin/activate
pip install .
pip install matplotlib cartopyWith Conda:conda env create -f environment.yml
conda activate clouddrift
conda install matplotlib-base cartopyThen, run the tests like this:python -m unittest tests/*.pyInstalling CloudDrift on unsupported platformsOne or more dependencies of CloudDrift may not have pre-built wheels for
platforms like IBM Power9 or Raspberry Pi.
If you are using pip to install CloudDrift and are getting errors during the
installation step, try installing CloudDrift using Conda.
If you still have issues installing CloudDrift, you may need to install system
dependencies first.
Please let us know by opening anissueand we will do our
best to help you.Found an issue or need help?Please create a new issuehereand provide as much detail as possible about your problem or question.