Merge pull request #19 from OceanParcels/lowercase_plasticparcels

Changing PlasticParcels to lowercase plasticparcels in documentation

Author: michaeldenes

README.md

@@ -1,20 +1,20 @@
-## PlasticParcels
-`PlasticParcels` is a python package for simulating the transport and dispersion of plastics in the ocean.
+## plasticparcels
+`plasticparcels` is a python package for simulating the transport and dispersion of plastics in the ocean.
 
 The tool is based on the [`Parcels`](https://oceanparcels.org/) computational Lagrangian ocean analysis framework ([@Lange2017](http://dx.doi.org/10.5194/gmd-10-4175-2017) and [@Delandmeter2019](http://dx.doi.org/10.5194/gmd-12-3571-2019)), providing a modular and customisable collection of methods, notebooks, and tutorials for advecting virtual plastic particles with a wide range of physical properties.
 
-![PlasticParcels](docs/_static/plasticparcelslogo.png)
+![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:
+`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/).
+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/)

docs/conf.py

@@ -12,7 +12,7 @@
 import sys
 import warnings
 
-project = 'PlasticParcels'
+project = 'plasticparcels'
 copyright = f'{datetime.datetime.now().year}, The OceanParcels Team'
 author = 'The OceanParcels Team'
 

docs/examples.rst

@@ -1,7 +1,7 @@
 Examples
 ========
 
-PlasticParcels has a few example notebooks, see below.
+``plasticparcels`` has a few example notebooks, see below.
 
 
 

docs/examples/example_Greece_coast.ipynb

@@ -17,7 +17,7 @@
     "# Library imports\n",
     "from datetime import datetime, timedelta\n",
     "\n",
-    "# Parcels and PlasticParcels imports\n",
+    "# parcels and plasticparcels imports\n",
     "import plasticparcels as pp\n",
     "\n",
     "# Plotting imports\n",

docs/examples/example_Italy_coast.ipynb

@@ -19,7 +19,7 @@
     "import xarray as xr\n",
     "import numpy as np\n",
     "\n",
-    "# Parcels and PlasticParcels imports\n",
+    "# parcels and plasticparcels imports\n",
     "import plasticparcels as pp\n",
     "\n",
     "# Plotting imports\n",

docs/index.rst

@@ -3,10 +3,10 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-PlasticParcels documentation
+Plasticparcels documentation
 ============================
 
-Welcome to the documentation of PlasticParcels.
+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.
 

plasticparcels/particlefile.py

@@ -4,5 +4,5 @@
 def ParticleFile(name, particleset, outputdt, settings, **kwargs):
     """Wrapper method to initialise a :class:`parcels.particlefile.ParticleFile` object from the ParticleSet."""
     pfile = pcls_particlefile(name=name, particleset=particleset, outputdt=outputdt, **kwargs)
-    pfile.add_metadata('PlasticParcels_settings', str(settings))
+    pfile.add_metadata('plasticparcels_settings', str(settings))
     return pfile

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools >= 61.0", "setuptools_scm[toml]>=6.2"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "PlasticParcels"
+name = "plasticparcels"
 description = "Package for simulating the transport and dispersion of plastics in the ocean."
 readme = "README.md"
 dynamic = ["version"]
@@ -33,8 +33,8 @@ dependencies = [
 
 [project.urls]
 homepage = "https://oceanparcels.org/"
-repository = "https://github.com/OceanParcels/PlasticParcels/"
-tracker = "https://github.com/OceanParcels/PlasticParcels/issues"
+repository = "https://github.com/OceanParcels/plasticparcels/"
+tracker = "https://github.com/OceanParcels/plasticparcels/issues"
 
 [tool.setuptools]
 packages = ["plasticparcels"]