Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Commit

Permalink
new screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
forman committed Sep 7, 2017
1 parent 2f54076 commit b5ceef0
Show file tree
Hide file tree
Showing 10 changed files with 71 additions and 15 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,9 @@ To install Cate for development and for the current user, use

$ python3 setup.py develop --user

Unfortunately, the installation fails on many platforms. In most cases the failure will be caused by the
`h5py` module dependency, which expects pre-installed HDF-5 C-libraries to be present on your computer.

On Windows, you may get around this by pre-installing the Cate dependencies (which you'll find in `setup.py`)
There is a **known issue on Windows** when installing into an existing Python environment. Installation may
fail due to an unresolved dependency to the `h5py` package, which expects pre-installed
HDF-5 C-libraries to be present on your computer. You may get around this by pre-installing the Cate dependencies (which you'll find in `setup.py`)
on your own, for example by using Christoph Gohlke's
[Unofficial Windows Binaries for Python Extension Packages](http://www.lfd.uci.edu/~gohlke/pythonlibs/).

Expand Down
Binary file modified doc/source/_static/figures/user_manual/gui_panel_layers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/_static/figures/user_manual/gui_panel_pacemarks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/_static/figures/user_manual/gui_panel_variables.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/_static/figures/user_manual/gui_panel_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/_static/figures/user_manual/gui_panel_workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion doc/source/downloads.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ Installers
The Cate software can be downloaded from the `Cate releases page`_ under the terms and conditions of
the `MIT open source license`_.

We make available separate installers for the Cate Python core and the Cate Desktop application.
We make available separate installers for *Cate Core* (Cate's Python environment, API, CLI, Service) and the
*Cate Desktop* application (Cate's GUI).

Please check the [] if you encounter any problems installing Cate.

Source Code
===========
Expand Down
23 changes: 23 additions & 0 deletions doc/source/known_issues.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _ESGF Portal at CEDA: https://esgf-index1.ceda.ac.uk/projects/esgf-ceda/
.. _ODP Datasets and Data Access Issues: https://github.com/CCI-Tools/cate-core/wiki/Problems-with-ODP-datasets-and-access
.. _ESA CCI Open Data Portal: http://cci.esa.int/
.. _Issue #64: https://github.com/CCI-Tools/cate-core/issues/64

============
Known Issues
============

Data Access
===========

1. When running Cate Core/Desktop on Windows and accessing data from the ESA Open Data Portal,
you may receive a **SSL certificate verify failed** error.
The workaround is to visit the `ESGF Portal at CEDA`_ web side using Edge, Chrome, or Firefox.
This will cause your browser to register the website URL in question with your operating system's
trusted SSL certificates. See also`Issue #64`_.

2. Not all datasets from offered by the `ESA CCI Open Data Portal`_ can be used in Cate.
Please check the `ODP Datasets and Data Access Issues`_ page to see whether you problem with
a dataset is known and if there are already fixes / workarounds.


37 changes: 31 additions & 6 deletions doc/source/support.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,43 @@
.. _Cate Core Issue Tracker: https://github.com/CCI-Tools/cate-core/issues
.. _Cate Desktop Issue Tracker: https://github.com/CCI-Tools/cate-desktop/issues
.. _Cate Issue Tracker: https://github.com/CCI-Tools/cate-core/issues

.. _pull requests: https://help.github.com/articles/creating-a-pull-request-from-a-fork/
.. _Cate repository on GitHub: https://github.com/CCI-Tools/cate-core

.. _ESGF Portal at CEDA: https://esgf-index1.ceda.ac.uk/projects/esgf-ceda/
.. _ODP Datasets and Data Access Issues: https://github.com/CCI-Tools/cate-core/wiki/Problems-with-ODP-datasets-and-access
.. _ESA CCI Open Data Portal: http://cci.esa.int/
.. _Issue #64: https://github.com/CCI-Tools/cate-core/issues/64


=======
Support
=======


Issues and feature requests related to the installation and use of the Cate CLI and the Cate Python API reported in the
`Cate Core Issue Tracker`_.
Issue Tracking
==============

Please post any support requests, bug report, or feature requests in the `Cate Issue Tracker`_.


Contributing
============

We are happy to receive `pull requests`_ from your fork of the `Cate repository on GitHub`_.


Known Issues
============

Issues and feature requests related to Cate Desktop GUI should be reported in the `Cate Desktop Issue Tracker`_.
Data Access
-----------

1. When running Cate Core/Desktop on Windows and accessing data from the ESA Open Data Portal,
you may receive a **SSL certificate verify failed** error.
The workaround is to visit the `ESGF Portal at CEDA`_ web side using Edge, Chrome, or Firefox.
This will cause your browser to register the website URL in question with your operating system's
trusted SSL certificates. See also`Issue #64`_.

We are happy to receive `pull requests`_ from your fork of the `Cate repository on GitHub`_.
2. Not all datasets from offered by the `ESA CCI Open Data Portal`_ can be used in Cate.
Please check the `ODP Datasets and Data Access Issues`_ page to see whether you problem with
a dataset is known and if there are already fixes / workarounds.
14 changes: 10 additions & 4 deletions doc/source/user_manual/um_gui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ explained in the following:
1. Download the complete remote dataset or a subset and make it a new *local* data source available from the
``local`` data store. Open the dataset from the new local data source. **This is currently the recommended way
to access remote data** as local data stores ensure sufficient I/O performance and are not bound to your internet
connection and remote service availablity.
connection and remote service availability.
2. Open the remote dataset without creating a local data copy. **This option should only be used for small subsets
of the data**, e.g. time series extractions within small spatial areas, as there is currently no way to observe
the data rate and status of data elements already transferred.
Expand All @@ -169,9 +169,15 @@ remote one. You can also provide a name for the new data source. By default, the
by "local".

.. note::
Downloading remote data may require a lot of free space on your local system. By default, Cate stores this data
in the user's home directory. On Linux and Mac OS, that is ``~/.cate/data_stores`, on Windows it is
``%USER_PROFILE%\.cate\data_stores``. Use the :ref:`preferences_dialog` to set an alternative location.
We strongly recommend to set the constraints to limit the overall amount of data to be downloaded
and stored. We are currently not able to pre-compute the amount of data and the time it will take to
fully download it.
Also note, that downloading remote data may require a lot of free space on your local system.
By default, Cate stores this data in the user's home directory. On Linux and Mac OS, that is
``~/.cate/data_stores`, on Windows it is
``%USER_PROFILE%\.cate\data_stores``.
Use the :ref:`preferences_dialog` to set an alternative location.


After confirming the dialog, a download task will be started, which can be observed in the **TASKS** panel.
Once the download is finished, a notification will be displayed and a new local data source will be available for the
Expand Down

0 comments on commit b5ceef0

Please sign in to comment.