Merge pull request #18 from OceanParcels/installation_instructions

Adding installation instructions

Author: erikvansebille

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)

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",

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 <https://anaconda.org/conda-forge/plasticparcels>`_ with the following command:
+
+.. code-block::
+
+   conda install conda-forge::plasticparcels
+
+
+Or downloaded from https://github.com/OceanParcels/PlasticParcels
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents