Getting started

xOPR is a Python package with relatively minimal depdencies. It is designed to be integrated with the xarray ecosystem, so, if you’re familiar with xarray, we hope you’ll feel at home.

If you’ve got a Python environment setup already, you can install xOPR using your choice of pip or uv (recommended). (If you haven’t come across uv yet, you can learn more here.)

pip install xopr

uv add xopr

Our documentation notebooks use a few extra packages. If you want to be able to run all of our notebooks, you can install xOPR with our docs extras:

pip install xopr[docs] # or xopr[all] for absolutely everything

uv add xopr[docs] # or xopr[all] for absolutely everything

You do not need to be working on the CReSIS servers to use xOPR. Unlike the rest of the OPR tooling, xOPR relies only on public data access, so you can run it wherever you like.

Working on a StratusGeo/CryoCloud/any JupyterHub¶

Working on StratusGeo (formerly known as CryoCloud) is a great option is you’re an existing CryoCloud user.

If you’re working in any JupyterHub environment, you can install xOPR by running this in a cell at the top of your notebook:

%pip install xopr # or xopr[docs]

Quick-start with Binder¶

If you just want to play around, you can launch a temporary JupyterHub instance to experiment. This will not save any of your work and is not a good way to do real work, but it’s a quick way to get started. To do this, just press the “Launch on Binder” button in the top right of this page.

What’s next?¶

If you’re a “read the instructions first” person, start by reading through the design notes and then start with our demo notebook.

If you like to skip the instructions, click on “Notebooks” on the left and pick an example that looks interesting!