Getting started#
If you have not completed setup yet, read Prerequisites first.
Quick checklist#
pip install --editable ./cryoswath
mkdir <project_dir>
cd <project_dir>
cryoswath create-config
cryoswath download-aux-data
cryoswath get-tutorials
Then open cryoswath.cfg in your project directory and confirm that the
[path] section points to the intended data location. The auxiliary
data command installs the Zenodo baseline, and the tutorial command copies
notebooks into tutorials/. The copied notebooks import CryoSwath from
the active Python environment. You can skip initialization for simple workflows
and let CryoSwath default to ./data, or set CRYOSWATH_DATA to choose a
data directory explicitly.
Warning
Use a dedicated environment for CryoSwath. Installing into a shared Python environment can break either CryoSwath or unrelated packages. Supported Python version is 3.12 or newer.
Warning
Starting Monday, February 16, 2026, users need an ESA EO account before running CryoSat download workflows.
Processing the first waveform#
If you are new to swath processing, it may be informative to follow the tutorial on (processing and) viewing a single waveform. While this is not the kind of data that you will need to analyze a glaciers evolution, this is its foundation. Knowledge about the smallest parts of the data can help you understand the larger picture.
Processing the first swath#
Similar to viewing a single waveform, you might wonder how swath data of a single track look like. Again, a single track will not tell you much about a glacier’s evolution, but it may help to understand higher level data.
Notebook: tutorials/tutorial__process_first_swath.ipynb will give you a hand using CryoSwath to process a single track and visualize the data.
General step-by-step tutorial#
The general step-by-step tutorial takes you from processing a waveform to producing a map of elevation change trends. It balances understanding the background processes with quickly enabling to use CryoSwath.