Cleaned installer, moved docs dependencies. resolves #1

mindearth · Aug 11, 2021 · 90427c0 · 90427c0
1 parent 1d987f9
commit 90427c0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,11 @@ You need to have a running version of `Dask` on your system. Once you have it yo
 
 If you already have [`scikit-mobility`](https://github.com/scikit-mobility/scikit-mobility) installed, skip the environment creation and run these commands from the skmob anaconda environment.
 
+`mobilkit` by default will only install core packages needed to run the main functions. There are three optional packages of dipendencies (the `mobilkit[complete]` installs everything):
+- `[viz]` will install `contextily`, needed to visualize map backgrounds in certain viz functions;
+- `[doc]` will install all the needed packages to build the docs;
+- `[skmob]` will install `scikit-mobility` as well.
+
 <a id='installation_conda'></a>
 ### Install with conda
 **TODO**

diff --git a/docs/index.rst b/docs/index.rst
@@ -99,6 +99,11 @@ Installation
 
 If you already have `scikit-mobility <https://github.com/scikit-mobility/scikit-mobility>`_ installed, skip the environment creation and run these commands from the `skmob` anaconda environment.
 
+`mobilkit` by default will only install core packages needed to run the main functions. There are three optional packages of dipendencies (the `mobilkit[complete]` installs everything):
+* `[viz]` will install `contextily`, needed to visualize map backgrounds in certain viz functions;
+* `[doc]` will install all the needed packages to build the docs;
+* `[skmob]` will install `scikit-mobility` as well.
+
 Test the installation
 =====================