Skip to content

Adding installation instructions #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erikvansebille merged 3 commits into from
May 6, 2024
Merged

Adding installation instructions #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6be6799
Adding installation instructions to README
erikvansebille May 6, 2024
694bdf7
Adding installation to docs
erikvansebille May 6, 2024
eede302
Updating link to inverted-logo
erikvansebille May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
13 changes: 13 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down