Skip to content

Commit 3fbced9

Browse files
committed
update README
1 parent c053f73 commit 3fbced9

File tree

2 files changed

+52
-36
lines changed

2 files changed

+52
-36
lines changed

README.md

Lines changed: 51 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,41 @@
11

2+
- [MODIStsp
3+
<img src='man/figures/logo.png' align="right" height="139" />](#modistsp)
4+
- [Citation](#citation)
5+
- [Website](#website)
6+
- [Important News \!](#important-news)
7+
- [Problems and Issues](#problems-and-issues)
8+
- [<i class="fa fa-desktop" aria-hidden="true"></i> System
9+
Requirements](#system-requirements)
10+
- [Installation Instructions](#installation-instructions)
11+
- [<i class="fa fa-windows" aria-hidden="true"></i> Installing on
12+
Windows](#installing-on-windows)
13+
- [<i class="fa fa-linux" aria-hidden="true"></i> Installing on
14+
Linux Systems](#installing-on-linux-systems)
15+
- [<i class="fa fa-apple" aria-hidden="true"></i> Installing on
16+
Mac](#installing-on-mac)
17+
- [Usage](#usage)
18+
- [Code of Conduct](#code-of-conduct)
19+
220
[![](https://www.r-pkg.org/badges/version-ago/MODIStsp)](https://cran.r-project.org/package=MODIStsp)
3-
[![](http://cranlogs.r-pkg.org/badges/MODIStsp)](https://cran.r-project.org/package=MODIStsp)
21+
[![](https://cranlogs.r-pkg.org/badges/MODIStsp)](https://cran.r-project.org/package=MODIStsp)
422
[![Travis-CI Build
523
Status](https://travis-ci.org/ropensci/MODIStsp.svg?branch=master)](https://travis-ci.org/ropensci/MODIStsp)
624
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1972039.svg)](https://doi.org/10.5281/zenodo.1972039)
725
[![Coverage
8-
Status](http://img.shields.io/codecov/c/github/ropensci/MODIStsp/master.svg)](http://codecov.io/github/ropensci/MODIStsp?branch=master)
9-
[![](http://badges.ropensci.org/184_status.svg)](https://github.com/ropensci/onboarding/issues/184)
26+
Status](https://img.shields.io/codecov/c/github/ropensci/MODIStsp/master.svg)](https://codecov.io/github/ropensci/MODIStsp?branch=master)
27+
[![](https://badges.ropensci.org/184_status.svg)](https://github.com/ropensci/onboarding/issues/184)
1028

1129
# MODIStsp <img src='man/figures/logo.png' align="right" height="139" />
1230

13-
[MODIStsp](http://docs.ropensci.org/MODIStsp/) is a “R” package devoted
14-
to automatizing the creation of time series of rasters derived from
15-
MODIS Land Products data. MODIStsp allows to perform several
16-
preprocessing steps (e.g., download, mosaicing, reprojection and resize)
17-
on MODIS data available within a given time period. Users have the
18-
ability to select which specific layers of the original MODIS HDF files
19-
they want to process. They also can select which additional Quality
20-
Indicators should be extracted from the aggregated MODIS Quality
31+
\========= [MODIStsp](https://docs.ropensci.org/MODIStsp/) is a “R”
32+
package devoted to automatizing the creation of time series of rasters
33+
derived from MODIS Land Products data. MODIStsp allows to perform
34+
several preprocessing steps (e.g., download, mosaicing, reprojection and
35+
resize) on MODIS data available within a given time period. Users have
36+
the ability to select which specific layers of the original MODIS HDF
37+
files they want to process. They also can select which additional
38+
Quality Indicators should be extracted from the aggregated MODIS Quality
2139
Assurance layers and, in the case of Surface Reflectance products, which
2240
Spectral Indexes should be computed from the original reflectance bands.
2341
For each output layer, outputs are saved as single-band raster files
@@ -52,10 +70,15 @@ Geosciences, Volume 97, Pages 40-48, ISSN 0098-3004,
5270

5371
For more information, documentation and examples of use, **see also the
5472
MODIStsp website at
55-
[docs.ropensci.org/MODIStsp](http://docs.ropensci.org/MODIStsp/)**
73+
[docs.ropensci.org/MODIStsp](https://docs.ropensci.org/MODIStsp/)**
5674

5775
## Important News \!
5876

77+
- 09/05/2020 - MODIStsp 1.4.0 is out. Switches to use of GDAL3/PROJ6
78+
WKTs for projection representation and usage of `sf` for all
79+
internal work on vector data. Adds support for products MCD19A1 and
80+
MCD19A2 products.
81+
5982
- 07/06/2019 - MODIStsp 1.3.9 is out. Fixes a bug causing crashes on
6083
MOD14A1 product, adds support for product MCD12Q2 and removes
6184
support for no longer available version 5 of some products.
@@ -105,15 +128,15 @@ MODIStsp website at
105128

106129
- 25/07/2017 - As of today, **most of the content related to MODIStsp
107130
has been moved to our new website at
108-
[docs.ropensci.org/MODIStsp](http://docs.ropensci.org/MODIStsp/)
131+
[docs.ropensci.org/MODIStsp](https://docs.ropensci.org/MODIStsp/)
109132
**, which provides a much better user interface and ease of access
110133
to MODIStsp-related information. From now on, please **consult the
111134
new website for detailed and updated information on the package**.
112135

113136
- Also our previous FAQ page on github containing info for solving
114137
common installation, downloading and processing problems and issues
115138
was discontinued and **migrated at
116-
[docs.ropensci.org/MODIStsp/articles/faq.html](http://docs.ropensci.org/MODIStsp/articles/faq.html)**.
139+
[docs.ropensci.org/MODIStsp/articles/faq.html](https://docs.ropensci.org/MODIStsp/articles/faq.html)**.
117140

118141
## Problems and Issues
119142

@@ -125,9 +148,9 @@ MODIStsp website at
125148

126149
`MODIStsp` requires [R](https://cran.r-project.org) v \>= 3.2.1 and
127150
[GDAL](http://www.gdal.org) (Geospatial Data Abstraction Library) v \>=
128-
1.11.1 **with support for HDF4 raster format** to be installed in your
151+
2.3 **with support for HDF4 raster format** to be installed in your
129152
system. Brief instructions for installing R and GDAL can be found
130-
[HERE](http://docs.ropensci.org/MODIStsp/articles/installation.html#installing-r-and-gdal).
153+
[HERE](https://docs.ropensci.org/MODIStsp/articles/installation.html#installing-r-and-gdal).
131154

132155
-----
133156

@@ -170,8 +193,7 @@ session from RStudio “Session” menu), reload RStudio and the try to
170193
reload `gWidgetsRGtk2`. If it loads correctly, you should be ready to
171194
go.
172195

173-
If it still fails, try downloading the GTK+ bundle
174-
from:
196+
If it still fails, try downloading the GTK+ bundle from:
175197

176198
<http://ftp.gnome.org/pub/gnome/binaries/win64/gtk+/2.22/gtk+-bundle_2.22.1-20101229_win64.zip>
177199
(OR
@@ -184,8 +206,7 @@ Files\\GTK+`), then add the path to its “bin” subfolder (e.g.,
184206
variable.
185207

186208
Restart your system and try loading again `gWidgetsRGtk2`: if it loads
187-
ok, you should be ready to install
188-
`MODIStsp`
209+
ok, you should be ready to install `MODIStsp`
189210

190211
## <i class="fa fa-linux" aria-hidden="true"></i> Installing on Linux Systems
191212

@@ -198,16 +219,14 @@ required dependencies:
198219
- `GDAL` \>= 1.6.3, `PROJ.4` \>= 4.4.9 (required by package `rgdal`)
199220

200221
On *Debian and Ubuntu-based* systems, to install those packages open a
201-
terminal and
202-
type:
222+
terminal and type:
203223

204224
``` bash
205225
sudo apt-get install r-cran-cairodevice r-cran-rgtk2 libcairo2-dev libatk1.0-dev libpango1.0-dev
206226
libgtk2.0-dev libglib2.0-dev libcurl4-openssl-dev libgdal-dev libproj-dev
207227
```
208228

209-
On *rpm-base systems*, to install packages open a terminal and
210-
type:
229+
On *rpm-base systems*, to install packages open a terminal and type:
211230

212231
``` bash
213232
sudo yum install libcairo2-devel libatk1.0-devel libpango1.0-devel gtk2 gtk2-devel
@@ -258,8 +277,7 @@ Sierra.
258277

259278
Install homebrew if you do not have it already installed. homebrew is a
260279
very convenient package manager for macOS. To do so, open a terminal,
261-
copy the following command in it and hit
262-
Enter:
280+
copy the following command in it and hit Enter:
263281

264282
``` bash
265283
~$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
@@ -329,8 +347,7 @@ emacs. Now install the library using:
329347

330348
<br>
331349

332-
**4. Update your path** so that `gtk+` is recognized,
333-
using:
350+
**4. Update your path** so that `gtk+` is recognized, using:
334351

335352
``` bash
336353
~$ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/local/lib/pkgconfig/gtk+-2.0.pc:/opt/X11/lib/pkgconfig
@@ -343,9 +360,9 @@ using:
343360
- **Download the newest source file for RGtk2** from
344361
<https://CRAN.R-project.org/package=gWidgetsRGtk2>.
345362

346-
- Assuming that the path to this file is ~/Downloads. Run the
363+
- Assuming that the path to this file is \~/Downloads. Run the
347364
following in terminal (change the path if you did not download in
348-
~/Downloads):
365+
\~/Downloads):
349366

350367
<!-- end list -->
351368

@@ -400,7 +417,7 @@ MODIStsp()
400417
This **opens a GUI** from which processing options can be specified (and
401418
eventually saved or loaded). After specifying all required parameters,
402419
clicking on “Start” will start the processing (see
403-
[HERE](http://docs.ropensci.org/MODIStsp/articles/interactive_execution.html)
420+
[HERE](https://docs.ropensci.org/MODIStsp/articles/interactive_execution.html)
404421
for more detailed instructions).
405422

406423
`MODIStsp` can also be launched in non-interactive mode within an `R`
@@ -419,14 +436,13 @@ MODIStsp(gui = FALSE, options_file = options_file)
419436
```
420437

421438
(see
422-
[HERE](http://docs.ropensci.org/MODIStsp/articles/noninteractive_execution.html)
439+
[HERE](https://docs.ropensci.org/MODIStsp/articles/noninteractive_execution.html)
423440
for more detailed instructions and examples).
424441

425442
# Code of Conduct
426443

427444
Please note that this project is released with a [Contributor Code of
428445
Conduct](https://github.com/ropensci/MODIStsp/blob/master/CONDUCT.md).
429-
By participating in this project you agree to abide by its
430-
terms.
446+
By participating in this project you agree to abide by its terms.
431447

432-
[![ropensci\_footer](http://ropensci.org/public_images/github_footer.png)](https://ropensci.org)
448+
[![ropensci\_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)

cran-comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ MODIStsp 1.4.0
1212

1313
There were no ERRORs, WARNINGs
1414

15-
There is a NOTE related to suggeting a orphaned package (gWidgets)
15+
There is a NOTE related to suggesting a orphaned package (gWidgets)
1616
I received a mail from Prof. Ripley about that recently. As suggested, I temporarily moved gWidgets to suggests and use it conditionally for the time being, with the intention of removing the dependency in the next MODIstsp release by switching to a Shiny-based GUI.
1717

1818
## Note on installation on macos

0 commit comments

Comments
 (0)