Prerequisites:
python --version
to check that your version of python is correct)brew install open-mpi
on macOS)brew install hdf5
on macOS)[!IMPORTANT]
Windows is not supported for development work – use WSL on Windows hosts
Installation:
[!NOTE] For testing purposes this repository uses Git Large File Storage (LFS) to handle large data files. If you want to clone the repository with the LFS files, make sure you have Git LFS installed on your system. You can download it from here. After installing, you can clone the repository as usual with
git clone
. Git LFS files will be downloaded automatically. If you've already cloned the repository, you can download the LFS files withgit lfs pull
.
Clone the repository:
Open a shell (bash, zsh) in the repository working directory
Create a new virtual environment named .venv
:
python -m venv .venv
Activate the environment
source ".venv/bin/activate"
Upgrade pip
pip install --upgrade pip
Install or update the environment with the dependencies for this project:
pip install --upgrade --editable ".[dev]"
You may need to set the value of the
HDF5_DIR
environment variable to install some of the dependencies, especially when installing on macOS.For Apple Silicon (M-Series) CPUs:
export HDF5_DIR="/opt/homebrew/opt/hdf5" pip install --upgrade --editable ".[dev]"
For Intel CPUs:
export HDF5_DIR="/usr/local/opt/hdf5" pip install --upgrade --editable ".[dev]"
Check the module icesat2waves
is available by loading the module:
python -c "import icesat2waves; print(icesat2waves.__version__)"
The icesat2waves
package comes with a command-line interface (CLI) that facilitates interaction with the package directly from your terminal. This can be particularly useful for scripting and automation. You can access the help documentation for the CLI by running the following command:
icesat2waves --help
As suggested in the help, to run a specific command run icesat2waves [OPTIONS] COMMAND [ARGS]...
. To view help on running a command, run icesat2waves COMMAND --help
. For example, to get help about the load-file
command, you may issue icesat2waves load-file --help
to get the following output:
(.venv) $ icesat2waves load-file --help
Usage: icesat2waves load-file [OPTIONS]
Open an ICEsat2 tbeam_stats.pyrack, apply filters and corrections, and
output smoothed photon heights on a regular grid in an .nc file.
Options:
--track-name TEXT [required]
--batch-key TEXT [required]
--id-flag / --no-id-flag [default: id-flag]
--output-dir TEXT [required]
--verbose / --no-verbose [default: no-verbose]
--help Show this message and exit.
Below is a sample workflow that leverages the included CLI.
Load single file
icesat2waves load-file --track-name 20190502052058_05180312_005_01 --batch-key SH_testSLsinglefile2 --output-dir ./output
Make spectra from downloaded data
icesat2waves make-spectra --track-name SH_20190502_05180312 --batch-key SH_testSLsinglefile2 --output-dir ./output
Plot spectra
icesat2waves plot-spectra --track-name SH_20190502_05180312 --batch-key SH_testSLsinglefile2 --output-dir ./output
Build IOWAGA priors
icesat2waves make-iowaga-threads-prior --track-name SH_20190502_05180312 --batch-key SH_testSLsinglefile2 --output-dir ./output
Build angles
icesat2waves make-b04-angle --track-name SH_20190502_05180312 --batch-key SH_testSLsinglefile2 --output-dir ./output
Define and plot angles
icesat2waves define-angle --track-name SH_20190502_05180312 --batch-key SH_testSLsinglefile2 --output-dir ./output
Make corrections and separations
icesat2waves correct-separate --track-name SH_20190502_05180312 --batch-key SH_testSLsinglefile2 --output-dir ./output