Merge pull request #377 from Living-with-machines/rw_docs

Update docs

docs/source/Install.rst

@@ -17,7 +17,7 @@ You should choose one method within each step and follow the instructions for th
 Step 1: Set up a virtual python environment
 ----------------------------------------------
 
-MapReader requires python version 3.7+.
+MapReader supports python versions 3.8 to 3.10.
 
 Method 1: Using conda (recommended)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -74,6 +74,16 @@ For example, if you would like to use venv, open your terminal and use the follo
 Step 2: Install MapReader
 --------------------------
 
+Cartopy
+~~~~~~~~
+
+`Cartopy <https://scitools.org.uk/cartopy/docs/latest/>`__ is used by MapReader's download subpackage to plot maps and geospatial data.
+It is not essential to the functioning of MapReader and so is not listed as a required dependancy.
+
+If you would like to use MapReader's plotting functions, you will need to ensure you have installed the `required dependencies <https://scitools.org.uk/cartopy/docs/latest/installing.html#required-dependencies>`__ for cartopy.
+
+Then, to install cartopy with your mapreader installation, you should install mapreader with the `geo` optional dependencies (see notes below).
+
 Method 1: Install from `PyPI <https://pypi.org/project/mapreader/>`_
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -86,6 +96,9 @@ This is probably the easiest way to install MapReader.
 
       pip install mapreader
 
+
+.. note:: Replace ``pip install mapreader`` with ``pip install "mapreader[geo]"`` if you would like to install cartopy with your mapreader installation.
+
 Method 2: Install from source
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -107,6 +120,9 @@ This method will create a ``MapReader`` directory on your machine which will con
       cd MapReader
       pip install -v -e .
 
+
+.. note:: Replace ``pip install -v -e .`` with ``pip install -v -e ".[geo]"`` if you would like to install cartopy with your mapreader installation.
+
 ..
    Method 3: Install via conda (**EXPERIMENTAL**)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -163,13 +179,3 @@ If you are using an M1 mac and are having issues installing MapReader due to an
 
       brew install openblas
       OPENBLAS="$(brew --prefix openblas)" pip install mapreader
-
-Cartopy
-~~~~~~~~
-
-`Cartopy <https://scitools.org.uk/cartopy/docs/latest/>`__ is used by MapReader's download subpackage to plot maps and geospatial data.
-It is not essential to the functioning of MapReader and so is not listed as a dependancy.
-
-If you would like to use MapReader's plotting functions, you should download cartopy by following the instructions `here <https://scitools.org.uk/cartopy/docs/latest/installing.html>`__.
-
-.. note:: There are some required dependencies which you may need to install first. These are listed `here <https://scitools.org.uk/cartopy/docs/latest/installing.html#required-dependencies>`__.

setup.py

@@ -26,7 +26,7 @@
     packages=setuptools.find_packages(),
     include_package_data=True,
     platforms="OS Independent",
-    python_requires=">=3.7, <3.11",
+    python_requires=">=3.8, <3.11",
     install_requires=[
         "matplotlib>=3.5.0,<4.0.0",
         "numpy>=1.21.5,<2.0.0",
@@ -67,8 +67,11 @@
             "transformers<5.0.0",
             "black>=23.7.0,<24.0.0",
             "flake8>=6.0.0,<7.0.0",
-        ]
-    },
+        ],
+        "geo": [
+            "cartopy>=0.20.0"
+        ],
+    },  
     classifiers=[
         "Development Status :: 3 - Alpha",
         "License :: OSI Approved :: MIT License",