Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.83 KB

INSTALL.md

File metadata and controls

51 lines (33 loc) · 1.83 KB
Raw

Installation

The quickest way to get started using task-geo is to launch a Binder environment.

Please click on the Binder button and follow the example notebooks!

However, you if you have to contribute changes to the code or run it in a different environment you will want to install it on your own.

Native Python

On UNIX-line systems such as MacOS and GNU/Linux, Task Geo can be installed natively using Python.

For this, you will need to first clone the repository and the execute make install inside it.

git clone https://github.com/CoronaWhy/task-geo.git
cd task-geo
make install

If you plan to contribute to the code, please check our Contributing Guide for more details about how to properly setup your environment.

Note that installing the library in Windows natively is not recommended, so if you are running a Windows system we recommend you to either switch to a UNIX-Like environment, or use the Docker installation method explained below.

Docker

Task Geo is also prepared to be run inside a docker environment using docker-compose.

This is not the ideal setup for development, but can be used to run the software on a Windows environment.

For this, make sure to have both docker and docker-compose installed on your system and then follow these steps:

  1. Clone this repository and go into the task-geo folder:
git clone https://github.com/CoronaWhy/task-geo.git
cd task-geo
  1. Start a Jupyter Notebook inside a docker container.
docker-compose up --build
  1. Point your browser at http://127.0.0.1:8888