Skip to content

Commit

Permalink
added contributors section, synced Docs page and Readme, reverted som…
Browse files Browse the repository at this point in the history
…e auth advise
  • Loading branch information
gena committed Mar 24, 2024
1 parent d92ab1c commit e23f504
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 54 deletions.
47 changes: 8 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,45 +10,6 @@ Check [User Guide](https://gee-community.github.io/qgis-earthengine-plugin/) to

![Add Sentinel-2 image](https://raw.githubusercontent.com/gee-community/qgis-earthengine-plugin/master/media/add_map_layer.png)

### Troubleshooting

#### How to reset your authentication settings (and also fix some authentication errors)?

Delete the credentials file and re-authenticate. The credentials file is located at:

```
Windows: C:\Users\USER\.config\earthengine\credentials
Linux: /home/USER/.config/earthengine/credentials
MacOS: /Users/USER/.config/earthengine/credentials
```

#### I am still getting authentication errors, what should I do?

Try installing the Google Earth Engine [command line client](https://developers.google.com/earth-engine/command_line). Run the `earthengine authenticate` command. This resets the authentication credentials and solves most authentication errors.

More about GEE authentication guide and troubleshooting [here](https://developers.google.com/earth-engine/guides/auth).

#### Are you through a proxy?

In your scripts, configure proxy settings on top of them:

```python
import os
os.environ['HTTP_PROXY'] = 'http://[username:password@]<ip_address_or_domain>:<port>'
os.environ['HTTPS_PROXY'] = 'http://[username:password@]<ip_address_or_domain>:<port>'

import ee
from ee_plugin import Map
```

#### I am getting error like ssl.SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed on MacOS:

Open Finder and double clicking on this file `/Applications/Python 3.6/Install Certificates.command`. This path may vary depending on how QGIS was installed (Homebrew, macports, native). Then restart QGIS.

#### Plugin crashes after authentication with a stack trace showing 404, what should I do?

Go to http://code.earthengine.google.com and make sure you can access code editor. If the plugin is still failing - make sure your IP is not under firewall.

### Roadmap

#### Alpha 0.0.1 (Q4 2019) :heavy_check_mark:
Expand Down Expand Up @@ -109,3 +70,11 @@ Go to http://code.earthengine.google.com and make sure you can access code edito
- [ ] Fetch (cache?) raster assets locally (EE > QGIS), for a given rectangle / CRS, as a Processing tool
- [ ] Export vector and raster data (QGIS > EE) either via Tasks or some other way
- [ ] Use QGIS vector/raster style editors to edit EE layer styles

### Contrubution

The project welcomes any contributions and is greateful to all existing contributors small or large listed on the GitHub Contributors page.

If you'd like to contribute code to the project - please make sure it's related to one of the reported project issues or discussion topics and feel free to submit a Pull Request and it will be considered for addition.

For any questions or disputes feel free to contact the original author of the project: gennadiy.donchyts@gmail.com
40 changes: 25 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
### QGIS Google Earth Engine plugin

**Current Version: 0.0.5 alpha**
**Current Version: 0.0.6 alpha**

Use [Discussions](https://github.com/gee-community/qgis-earthengine-plugin/discussions) to leave a comment about the plugin or [Issues](https://github.com/gee-community/qgis-earthengine-plugin/issues) page to report bugs or new feature requests.

Expand Down Expand Up @@ -70,27 +68,39 @@ Note that QGIS projects containing EE map layers can be also saved, in this case

Check [examples](https://github.com/gee-community/qgis-earthengine-plugin/tree/master/examples) directory to learn what kind of functionality is currently supported.

### FAQ
Q: I am getting authentication errors, what can I do?
### Troubleshooting

#### How to reset your authentication settings?

Install the Google Earth Engine [command line client](https://developers.google.com/earth-engine/command_line). Run the `earthengine authenticate` command. This resets the authentication credentials and solves most authentication errors.

More about GEE authentication guide and troubleshooting [here](https://developers.google.com/earth-engine/guides/auth).

A: Try installing the Google Earth Engine [command line client](https://developers.google.com/earth-engine/command_line). Run the `earthengine authenticate` command. This resets the authentication credentials and solves most authentication errors.
#### Are you through a proxy?

Q: I am getting error like ssl.SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed on MacOS:
In your scripts, configure proxy settings on top of them:

A: Open Finder and double clicking on this file `/Applications/Python 3.6/Install Certificates.command`. This path may vary depending on how QGIS was installed (Homebrew, macports, native). Then restart QGIS.
```python
import os
os.environ['HTTP_PROXY'] = 'http://[username:password@]<ip_address_or_domain>:<port>'
os.environ['HTTPS_PROXY'] = 'http://[username:password@]<ip_address_or_domain>:<port>'

Q: Plugin crashes after authentication with a stack trace showing 404, what should I do?
import ee
from ee_plugin import Map
```

A: Go to http://code.earthengine.google.com and make sure you can access code editor. If the plugin is still failing - make sure your IP is not under firewall.
#### I am getting error like ssl.SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed on MacOS:

### Support Ukraine
Open Finder and double clicking on this file `/Applications/Python 3.6/Install Certificates.command`. This path may vary depending on how QGIS was installed (Homebrew, macports, native). Then restart QGIS.

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)
#### Plugin crashes after authentication with a stack trace showing 404, what should I do?

### Donate
Go to http://code.earthengine.google.com and make sure you can access code editor. If the plugin is still failing - make sure your IP is not under firewall.

Consider supporting this project:
### Contrubution

[![Donate](https://www.paypalobjects.com/en_US/NL/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=P2RU23F4ETP4L&item_name=QGIS+Plugin+Development&currency_code=EUR&source=url) or just <a href="https://www.buymeacoffee.com/Eq378D1"><img src="https://cdn.buymeacoffee.com/buttons/default-white.png" width="150"></a>
The project welcomes any contributions and is greateful to all existing contributors small or large listed on the GitHub Contributors page.

If you'd like to contribute code to the project - please make sure it's related to one of the reported project issues or discussion topics and feel free to submit a Pull Request and it will be considered for addition.

For any questions or disputes feel free to contact the original author of the project: gennadiy.donchyts@gmail.com

0 comments on commit e23f504

Please sign in to comment.