Skip to content

Commit 39e42d3

Browse files
committed
Update README for 4.0
1 parent 5398eef commit 39e42d3

1 file changed

Lines changed: 11 additions & 13 deletions

File tree

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# `gds_env`: A containerised platform for Geographic Data Science
22

3-
[![](https://images.microbadger.com/badges/image/darribas/gds:3.0.svg)](https://microbadger.com/images/darribas/gds:3.0 "Get your own image badge on microbadger.com")
4-
[![](https://images.microbadger.com/badges/version/darribas/gds:3.0.svg)](https://microbadger.com/images/darribas/gds:3.0 "Get your own version badge on microbadger.com")
3+
[![](https://images.microbadger.com/badges/image/darribas/gds:4.0.svg)](https://microbadger.com/images/darribas/gds:4.0 "Get your own image badge on microbadger.com")
4+
[![](https://images.microbadger.com/badges/version/darribas/gds:4.0.svg)](https://microbadger.com/images/darribas/gds:4.0 "Get your own version badge on microbadger.com")
55
[![DOI](https://zenodo.org/badge/65582539.svg)](https://zenodo.org/badge/latestdoi/65582539)
66

77
* [Dani Arribas-Bel](http://darribas.org)
88
[[@darribas](http://twitter.com/darribas)]
99

1010
This repository contains a `docker` container that includes:
1111

12-
* A full Python stack ready for geospatial analysis (see `gds_stack.yml` for a detailed list).
13-
* A full R stack ready for geospatial analysis (see `install.R` for a detailed list).
14-
* Both the [`IRkernel`](https://github.com/IRkernel/IRkernel) and [`rpy2`](https://bitbucket.org/rpy2/rpy2) channels to interact with R through Python.
15-
* A full LaTeX distribution.
16-
* Additional development utilities (e.g. `pandoc`, `git`, `decktape`, etc.).
17-
18-
It is rather heavy (around 10GB) but it is meant to provide a fully isolated environment that can be deployed in a wide array of contexts and encompass several situations.
12+
* `[gds_py]`: a full LaTeX distribution.
13+
* `[gds_py]`: a full Python stack ready for geospatial analysis (see [`stack_py.txt`](stack_py.txt) for a detailed list).
14+
* `[gds]`: `gds_py` + a full R stack ready for geospatial analysis (see [`stack_r.txt`](stack_r.txt) for a detailed list).
15+
* `[gds]`: both the [`IRkernel`](https://github.com/IRkernel/IRkernel) and [`rpy2`](https://bitbucket.org/rpy2/rpy2) channels to interact with R through Jupyter.
16+
* `[gds_dev]`: `gds` + additional development utilities (e.g. `pandoc`, `git`, `decktape`, `jekyll`, `jupyter-book`, `bookdown`).
1917

2018
## Requirements
2119

@@ -25,15 +23,15 @@ You will need [Docker](https://www.docker.com) to be able to install the GDS env
2523

2624
You can install this container by simply running:
2725

28-
> `docker pull darribas/gds:3.0`
26+
> `docker pull darribas/gds:4.0`
2927
3028
[Note that you'll need [Docker](https://www.docker.com) installed on your machine]
3129

3230
## Building
3331

3432
If, instead, you want to build from source, the Docker image can be built by running:
3533

36-
> `docker build -t darribas/gds:3.0 .`
34+
> `docker build -t darribas/gds:4.0 .`
3735
3836
You can check it has been built correctly by:
3937

@@ -46,7 +44,7 @@ And you should see one image with the name `gds`.
4644
The container can be run as:
4745

4846
```
49-
> docker run --rm -ti -p 8888:8888 -v ${pwd}:/home/jovyan/host darribas/gds:3.0
47+
> docker run --rm -ti -p 8888:8888 -v ${pwd}:/home/jovyan/host darribas/gds:4.0
5048
```
5149

5250
<img src="JupyterLab.png" width="500">
@@ -67,7 +65,7 @@ A couple of notes on the command above:
6765
author = {{Dani Arribas-Bel}},
6866
title = {\texttt{gds\_env}: A containerised platform for Geographic Data Science},
6967
url = {https://github.com/darribas/gds_env},
70-
version = {3.0},
68+
version = {4.0},
7169
date = {2019-08-06},
7270
}
7371
```

0 commit comments

Comments
 (0)