From 6be679976471d0b10ecb43745f5575d511efeb17 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Mon, 6 May 2024 08:38:57 +0200 Subject: [PATCH 1/3] Adding installation instructions to README --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 520671d..f734ff7 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,18 @@ The tool is based on the [`Parcels`](https://oceanparcels.org/) computational La ![PlasticParcels](docs/_static/plasticparcelslogo.png) +### Installation + +`PlasticParcels` can be installed using `conda` from the [`conda-forge` channel](https://anaconda.org/conda-forge/plasticparcels) with the following command: + +```bash +conda install conda-forge::plasticparcels +``` + +### Further information For more information and documentation, see the [PlasticParcels documentation](https://plastic.oceanparcels.org/). [![unit-tests](https://github.com/OceanParcels/plasticparcels/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/OceanParcels/plasticparcels/actions/workflows/unit_tests.yml) +[![Anaconda-release](https://anaconda.org/conda-forge/plasticparcels/badges/version.svg)](https://anaconda.org/conda-forge/plasticparcels/) +[![Anaconda-date](https://anaconda.org/conda-forge/plasticparcels/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/plasticparcels/) [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.823561.svg)](https://doi.org/10.5281/zenodo.823561) From 694bdf7a95cbc55c4d87acde87e61e21d689ef8b Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Mon, 6 May 2024 08:48:08 +0200 Subject: [PATCH 2/3] Adding installation to docs --- docs/index.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index e094deb..54ae526 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,19 @@ Welcome to the documentation of PlasticParcels. ``plasticparcels`` is a python package for simulating the transport and dispersion of plastics in the ocean. The tool is based on the ``parcels`` computational Lagrangian ocean analysis framework, providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties. +Installation +^^^^^^^^^^^^ + +``plasticparcels`` can be installed using ``conda`` from the `conda-forge channel `_ with the following command: + +.. code-block:: + + conda install conda-forge::plasticparcels + + +Or downloaded from https://github.com/OceanParcels/PlasticParcels + + .. toctree:: :maxdepth: 2 :caption: Contents From eede302f8916bff209907ab9b5386ea8f1863d51 Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Mon, 6 May 2024 08:48:20 +0200 Subject: [PATCH 3/3] Updating link to inverted-logo --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d3602ef..3b016e5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -50,7 +50,7 @@ html_theme_options = { "logo": { "image_light": "plasticparcelslogo.png", - "image_dark": "plasticparcelslogo-inverted.png", # TODO create this + "image_dark": "plasticparcelslogo_inverted.png", }, # "use_edit_page_button": True, "github_url": "https://github.com/OceanParcels/plasticparcels",