Skip to content

Commit 6a8a5f6

Browse files
jonasViehwegerjonasViehweger
authored
Merge pull request #292 from sentinel-hub/fix/structure
Fix/structure
2 parents 27b2cab + 94462dd commit 6a8a5f6

File tree

29 files changed

+301
-140
lines changed

29 files changed

+301
-140
lines changed

‎README.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Sentinel Hub Custom Script Repository
2+
3+
![Examples of visualizations](assets/images/custom-scripts-examples.jpg)
4+
5+
This repository contains a collection of custom scripts for [Sentinel Hub](https://www.sentinel-hub.com/), which can be fed to the services via the URL.
6+
7+
Custom scripts are a piece of Javascript code, used to visualize satellite imagery and to control what values the Sentinel Hub services will return. Any visualization of any constellation (e.g. Sentinel-2 satellite), even a simple true color composite, is dictated by a custom script.
8+
9+
See [here](https://docs.sentinel-hub.com/api/latest/evalscript/v3/) for more information on how to write your own evalscript.
10+
11+
## Contribute to Custom Scripts
12+
13+
Have a look at the [template](/contribute/example) for an example of how a script page can be structured.
14+
15+
You can also have a look at other scripts to see how they are structured.
16+
17+
For instructions on how custom scripts are structured have a look at this [tutorial](https://www.sentinel-hub.com/explore/education/custom-scripts-tutorial/), or at the [official documenation](https://docs.sentinel-hub.com/api/latest/evalscript/).
18+
19+
---
20+
21+
### How to publish your own product
22+
23+
- Fork the repository to get your own copy of the custom-scripts
24+
_It is easiest to fork the repository on GitHub, but as some of you might not have GitHub account, or don't want to bother with all this versioning and collaboration tools, you can also just download the whole repository as Zip file and work from there._
25+
- Create a new directory entry for your custom script
26+
_Copy the `example` directory to proper directory, based on which datasource (satellite) you are publishing the product for, to something that describes what the product is about, say `my_algorithm`._
27+
_Preferably use ["snake_case"](https://simple.wikipedia.org/wiki/Snake_case) (underscores instead of spaces) if more than one word is used._
28+
- Fill in the details about the project in the `README.md` file.
29+
_Obviously, you'll want to remove this chapter, but use the rest of the file as a template._
30+
_Have a look around at other `README.md` files to see how to include images, format the text and generally use the GitHub [markdown](https://help.github.com/categories/writing-on-github/) (e.g. [here](../sentinel-2/cby_cloud_detection/README.md) for mathematical formulas or [here](../sentinel-2/ndvi_uncertainty/README.md) for adding images)._
31+
- Implement the product in the `script.js` file.
32+
_The most work is of course the JavaScript implementation of the product. The `example` folder includes an empty custom script with comments that will hopefully help you build your own custom script. Of course the easiest is to do the custom script building/testing on [Sentinel Playground](https://apps.sentinel-hub.com/sentinel-playground/)._
33+
- Add an entry pointing to your script to the top level markdown file (i.e. if adding a script for Sentinel 2 add the link to `sentinel-2.md` in the folder `sentinel-2`).
34+
_A link and a short description will do._
35+
- And create a pull request :).
36+
_There is extensive help on creating pull requests on GitHub [help](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/), but if you feel overwhelmed by this step and would still like to contribute, send us the folder you've created and we will take care of it for you._
37+
38+
Publishing your product should be easy, nevertheless, any feedback and ideas how to improve or make the process simpler is very appreciated.
39+
40+
#### Test your changes locally
41+
42+
This is optional but makes Pull Requests quicker to handle since they should have less mistakes.
43+
Before you create the PR you can check if everything looks right on the website. To do this follow these steps which are based on [Testing your GitHub Pages site locally with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) page:
44+
45+
##### Linux
46+
47+
- In the root directory of your fork open a terminal
48+
- Install ruby
49+
- Ubuntu: `sudo apt install ruby ruby-dev`
50+
- Install bundler
51+
- `gem install bundler`
52+
- On Ubuntu you might have to add `sudo`
53+
- Create a Gemfile
54+
- In the root folder of the repository (where the `_config.yml` file is) create a new file `Gemfile`.
55+
- i.e `touch Gemfile`
56+
- and add the following content:
57+
58+
```
59+
source 'https://rubygems.org'
60+
gem "github-pages", "~> GH_VERSION", group: :jekyll_plugins
61+
gem "just-the-docs"
62+
```
63+
64+
Replace `GH_VERSION` with the version number that is displayed next to github-pages [here](https://pages.github.com/versions/).
65+
66+
- Serve the page
67+
- First install all necessary gems with `bundle install`
68+
- then the site can be built with `bundle exec jekyll serve`
69+
- The site should then be visible on `127.0.0.1:4000`
70+
71+
##### macOS
72+
73+
- In the root directory of your fork open a terminal
74+
- Install ruby
75+
76+
- `brew install chruby ruby-install xz`
77+
78+
- If homebrew hasn't been installed yet, intall homebrew
79+
80+
```
81+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
82+
```
83+
84+
- `ruby-install ruby 3.1.3`
85+
- After installation run the following codes:
86+
87+
```
88+
echo "source $(brew --prefix)/opt/chruby/share/chruby/chruby.sh" >> ~/.zshrc
89+
echo "source $(brew --prefix)/opt/chruby/share/chruby/auto.sh" >> ~/.zshrc
90+
echo "chruby ruby-3.1.3" >> ~/.zshrc # run 'chruby' to see actual version
91+
```
92+
93+
- Quit and relaunch Terminal, then check that everything with `ruby -v`
94+
- It should show ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) or a newer version
95+
96+
- Install Jekyll
97+
- `gem install jekyll`
98+
- Install bundler
99+
- `gem install bundler`
100+
- Following the **Create a Gemfile** step in the Linux section
101+
- Serve the page
102+
103+
- First install all necessary gems with `bundle install`
104+
- Add the missing webrick package with `bundle add webrick`
105+
106+
- Run this command again when the following error message pops out:
107+
108+
```
109+
bundler: failed to load command: jekyll
110+
```
111+
112+
- then the site can be built with `bundle exec jekyll serve`
113+
- The site should then be visible on `127.0.0.1:4000`

‎_config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ url: https://custom-scripts.sentinel-hub.com
88
math: mathjax
99
enable_copy_code_button: true
1010

11+
exclude: ["README.md"]
12+
1113
logo: "/assets/images/sentinel_hub_logo_with_custom_scripts.png"
1214
favicon_ico: "/assets/images/public_favicon.ico"
1315

‎contribute/example/README.md

-18
This file was deleted.

‎contribute/example/index.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Example product
3+
parent: Contribute
4+
5+
layout: script
6+
nav_exclude: true
7+
---
8+
9+
The layout `script` automatically adds the title defined in the front matter and adds buttons to visualize the script. For the buttons to work the evalscript has to be named `script.js` and must be in the same directory as the `README.md` file.
10+
11+
## Evaluate and visualize
12+
13+
- [EO Browser](https://apps.sentinel-hub.com/eo-browser/#lat=41.9&lng=12.5&zoom=10&datasource=Sentinel-2%20L1C&time=2017-10-08&preset=CUSTOM&layers=B01,B02,B03&evalscripturl=https://raw.githubusercontent.com/sentinel-hub/customScripts/master/example/script.js){:target="\_blank"}
14+
15+
## General description of the script
16+
17+
## References
18+
19+
- possible references (scientific articles, wiki/web references, ...)

‎contribute/example_multiple_scripts/README.md

-22
This file was deleted.

‎contribute/example_multiple_scripts/index.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Example product
3+
parent: Contribute
4+
layout: script
5+
nav_exclude: true
6+
scripts:
7+
- [Visualization, script.js]
8+
- [EO Browser, eob.js]
9+
- [Raw Values, raw.js]
10+
---
11+
12+
The layout `script` automatically adds the title defined in the front matter and adds buttons to visualize the script. For the buttons to work the evalscript has to be named `script.js` and must be in the same directory as the `README.md` file.
13+
14+
## Evaluate and visualize
15+
16+
- [EO Browser](https://apps.sentinel-hub.com/eo-browser/#lat=41.9&lng=12.5&zoom=10&datasource=Sentinel-2%20L1C&time=2017-10-08&preset=CUSTOM&layers=B01,B02,B03&evalscripturl=https://raw.githubusercontent.com/sentinel-hub/customScripts/master/example/script.js){:target="\_blank"}
17+
18+
## General description of the script
19+
20+
## References
21+
22+
- possible references (scientific articles, wiki/web references, ...)

‎contribute/contribute.md ‎contribute/index.md

+26-22
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ layout: default
33
title: Contribute
44
nav_order: 99
55
has_children: false
6-
permalink: /contribute/
76
---
87

98
# Contribute to Custom Scripts
@@ -18,25 +17,20 @@ For instructions on how custom scripts are structured have a look at this [tutor
1817

1918
## How to publish your own product
2019

21-
* Fork the repository to get your own copy of the custom-scripts
20+
- Fork the repository to get your own copy of the custom-scripts
2221
_It is easiest to fork the repository on GitHub, but as some of you might not have GitHub account, or don't want to bother with all this versioning and collaboration tools, you can also just download the whole repository as Zip file and work from there._
23-
24-
* Create a new directory entry for your custom script
25-
*Copy the `example` directory to proper directory, based on which datasource (satellite) you are publishing the product for, to something that describes what the product is about, say `my_algorithm`.*
26-
*Preferably use ["snake_case"](https://simple.wikipedia.org/wiki/Snake_case) (underscores instead of spaces) if more than one word is used.*
27-
28-
* Fill in the details about the project in the `README.md` file.
29-
*Obviously, you'll want to remove this chapter, but use the rest of the file as a template.*
30-
*Have a look around at other `README.md` files to see how to include images, format the text and generally use the GitHub [markdown](https://help.github.com/categories/writing-on-github/) (e.g. [here](../sentinel-2/cby_cloud_detection/README.md) for mathematical formulas or [here](../sentinel-2/ndvi_uncertainty/README.md) for adding images).*
31-
32-
* Implement the product in the `script.js` file.
33-
*The most work is of course the JavaScript implementation of the product. The `example` folder includes an empty custom script with comments that will hopefully help you build your own custom script. Of course the easiest is to do the custom script building/testing on [Sentinel Playground](https://apps.sentinel-hub.com/sentinel-playground/).*
34-
35-
* Add an entry pointing to your script to the top level markdown file (i.e. if adding a script for Sentinel 2 add the link to `sentinel-2.md` in the folder `sentinel-2`).
36-
*A link and a short description will do.*
37-
38-
* And create a pull request :).
39-
*There is extensive help on creating pull requests on GitHub [help](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/), but if you feel overwhelmed by this step and would still like to contribute, send us the folder you've created and we will take care of it for you.*
22+
- Create a new directory entry for your custom script
23+
_Copy the `example` directory to proper directory, based on which datasource (satellite) you are publishing the product for, to something that describes what the product is about, say `my_algorithm`._
24+
_Preferably use ["snake_case"](https://simple.wikipedia.org/wiki/Snake_case) (underscores instead of spaces) if more than one word is used._
25+
- Fill in the details about the project in the `README.md` file.
26+
_Obviously, you'll want to remove this chapter, but use the rest of the file as a template._
27+
_Have a look around at other `README.md` files to see how to include images, format the text and generally use the GitHub [markdown](https://help.github.com/categories/writing-on-github/) (e.g. [here](../sentinel-2/cby_cloud_detection/README.md) for mathematical formulas or [here](../sentinel-2/ndvi_uncertainty/README.md) for adding images)._
28+
- Implement the product in the `script.js` file.
29+
_The most work is of course the JavaScript implementation of the product. The `example` folder includes an empty custom script with comments that will hopefully help you build your own custom script. Of course the easiest is to do the custom script building/testing on [Sentinel Playground](https://apps.sentinel-hub.com/sentinel-playground/)._
30+
- Add an entry pointing to your script to the top level markdown file (i.e. if adding a script for Sentinel 2 add the link to `sentinel-2.md` in the folder `sentinel-2`).
31+
_A link and a short description will do._
32+
- And create a pull request :).
33+
_There is extensive help on creating pull requests on GitHub [help](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/), but if you feel overwhelmed by this step and would still like to contribute, send us the folder you've created and we will take care of it for you._
4034

4135
Publishing your product should be easy, nevertheless, any feedback and ideas how to improve or make the process simpler is very appreciated.
4236

@@ -46,6 +40,7 @@ This is optional but makes Pull Requests quicker to handle since they should hav
4640
Before you create the PR you can check if everything looks right on the website. To do this follow these steps which are based on [Testing your GitHub Pages site locally with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll) page:
4741

4842
#### Linux
43+
4944
- In the root directory of your fork open a terminal
5045
- Install ruby
5146
- Ubuntu: `sudo apt install ruby ruby-dev`
@@ -54,7 +49,7 @@ Before you create the PR you can check if everything looks right on the website.
5449
- On Ubuntu you might have to add `sudo`
5550
- Create a Gemfile
5651
- In the root folder of the repository (where the `_config.yml` file is) create a new file `Gemfile`.
57-
- i.e `touch Gemfile`
52+
- i.e `touch Gemfile`
5853
- and add the following content:
5954

6055
```
@@ -63,22 +58,26 @@ gem "github-pages", "~> GH_VERSION", group: :jekyll_plugins
6358
gem "just-the-docs"
6459
```
6560

66-
Replace `GH_VERSION` with the version number that is displayed next to github-pages [here](https://pages.github.com/versions/).
61+
Replace `GH_VERSION` with the version number that is displayed next to github-pages [here](https://pages.github.com/versions/).
6762

6863
- Serve the page
6964
- First install all necessary gems with `bundle install`
7065
- then the site can be built with `bundle exec jekyll serve`
7166
- The site should then be visible on `127.0.0.1:4000`
7267

7368
#### macOS
69+
7470
- In the root directory of your fork open a terminal
7571
- Install ruby
72+
7673
- `brew install chruby ruby-install xz`
77-
- If homebrew hasn't been installed yet, intall homebrew
74+
75+
- If homebrew hasn't been installed yet, intall homebrew
7876

7977
```
8078
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
8179
```
80+
8281
- `ruby-install ruby 3.1.3`
8382
- After installation run the following codes:
8483
@@ -87,20 +86,25 @@ Replace `GH_VERSION` with the version number that is displayed next to github-pa
8786
echo "source $(brew --prefix)/opt/chruby/share/chruby/auto.sh" >> ~/.zshrc
8887
echo "chruby ruby-3.1.3" >> ~/.zshrc # run 'chruby' to see actual version
8988
```
89+
9090
- Quit and relaunch Terminal, then check that everything with `ruby -v`
9191
- It should show ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) or a newer version
92+
9293
- Install Jekyll
9394
- `gem install jekyll`
9495
- Install bundler
9596
- `gem install bundler`
9697
- Following the **Create a Gemfile** step in the Linux section
9798
- Serve the page
99+
98100
- First install all necessary gems with `bundle install`
99101
- Add the missing webrick package with `bundle add webrick`
102+
100103
- Run this command again when the following error message pops out:
101104
102105
```
103106
bundler: failed to load command: jekyll
104107
```
108+
105109
- then the site can be built with `bundle exec jekyll serve`
106110
- The site should then be visible on `127.0.0.1:4000`

0 commit comments

Comments
 (0)