This repository contains the code of the Ocean Plastic Assimilator, a program to perform data assimilation on a dispersion of particles.
The required packages to perform a simulations are available in the environment.yml file.
You can install them easily with conda. Please note that you will need to add the conda-forge channels to your config:
conda config --add channels conda-forge
conda config --set channel_priority strict
conda env create -f environment.yml
conda activate ocean-plastic-assimilator
then use one of the example scripts in examples/ as a template for your use case.
If you are looking at running the experiments and examples presented in the paper submitted to Geoscientific Model Development, use the examples_index.ipynb notebook to automatically download the required data and start the experiments.
See the dedicated documentation file.
Follow the instructions in the notebook examples.ipynb to run the experiments described in the paper, or copy one of the example start scripts in examples/ in the root directory and start it.
These notebooks are in the analysis/ folder.
Copyright (C) 2020-2021 The Ocean Cleanup™
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/