From 90427c041f1acc870d41d2f4bdeadd2a7b9fbc39 Mon Sep 17 00:00:00 2001 From: MindEarth Date: Wed, 11 Aug 2021 16:18:26 +0200 Subject: [PATCH] Cleaned installer, moved docs dependencies. resolves #1 --- README.md | 5 +++++ docs/index.rst | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/README.md b/README.md index 59118e5..8ba5804 100644 --- 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. + ### Install with conda **TODO** diff --git a/docs/index.rst b/docs/index.rst index e9d3396..7d0603e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -99,6 +99,11 @@ Installation If you already have `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 =====================