Skip to content

Commit 48fcb6e

Browse files
committed
update README with universal conda lock instructions
1 parent c500900 commit 48fcb6e

File tree

1 file changed

+5
-23
lines changed

1 file changed

+5
-23
lines changed

README.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Summary
99

10-
This combined repository includes tutorials and code resources provided by the NASA National Snow and Ice Data Center Distributed Active Archive Center (NSIDC DAAC). These tutorials are provided as Python-based Jupyter notebooks that provide guidance on working with various data products, including how to access, subset, transform, and visualize data. Each tutorial can be accessed by navigating to the /notebooks folder of this repository. Please see the README files associated with each individual tutorial folder for more information on each tutorial and their learning objectives. Please note that all branches outside of `Main` should be considered in development and are not supported.
10+
This combined repository includes tutorials and code resources provided by the NASA National Snow and Ice Data Center Distributed Active Archive Center (NSIDC DAAC). These tutorials are provided as Python-based Jupyter notebooks that provide guidance on working with various data products, including how to access, subset, transform, and visualize data. Each tutorial can be accessed by navigating to the /notebooks folder of this repository. Please see the README files associated with each individual tutorial folder for more information on each tutorial and their learning objectives. Please note that all branches outside of `Main` should be considered in development and are not supported.
1111

1212
## Tutorials
1313

@@ -31,7 +31,7 @@ This notebook utilizes several libraries to performantly search, access, read, a
3131

3232
**Download, crop, resample, and plot multiple GeoTIFFs**
3333

34-
This tutorial guides you through programmatically accessing and downloading GeoTIFF files from the NSIDC DAAC to your local computer. We then crop and resample one GeoTIFF based on the extent and pixel size of another GeoTIFF, then plot one on top of the other.
34+
This tutorial guides you through programmatically accessing and downloading GeoTIFF files from the NSIDC DAAC to your local computer. We then crop and resample one GeoTIFF based on the extent and pixel size of another GeoTIFF, then plot one on top of the other.
3535

3636
We will use two data sets from the NASA [MEaSUREs](https://nsidc.org/data/measures) (Making Earth System data records for Use in Research Environments) program as an example:
3737

@@ -71,7 +71,6 @@ The notebooks on this project demonstrate how to search and access ITS_LIVE velo
7171
> [ICESat/GLAS](https://icesat.gsfc.nasa.gov/icesat/) and
7272
> [ICESat-2](https://icesat-2.gsfc.nasa.gov/).
7373
74-
7574
## Usage with Binder
7675

7776
The Binder button above allows you to explore and run the notebook in a shared cloud computing environment without the need to install dependencies on your local machine. Note that this option will not directly download data to your computer; instead the data will be downloaded to the cloud environment.
@@ -80,7 +79,6 @@ The Binder button above allows you to explore and run the notebook in a shared c
8079

8180
### On Mac OSX or Linux
8281

83-
8482
1. Install [Docker](https://docs.docker.com/install/). Use the left-hand navigation to select the appropriate install depending on operating system.
8583

8684
2. Download the [NSIDC-Data-Tutorials repository from Github](https://github.com/nsidc/NSIDC-Data-Tutorials/archive/master.zip).
@@ -127,7 +125,6 @@ If you started your container with the `-d`/`--detach` option, check `docker log
127125

128126
6. You will be brought to a Jupyter Notebook interface running through the Docker container. The left side of the interface displays your local directory structure. Navigate to the **`work`** folder of the `NSIDC-Data-Tutorials` repository folder. You can now interact with the notebooks to explore and access data.
129127

130-
131128
### On Windows
132129

133130
1. Install [Docker](https://docs.docker.com/docker-for-windows/install/).
@@ -185,29 +182,16 @@ If you started your container with the `-d`/`--detach` option, check `docker log
185182
186183
1. Install mambaforge (Python 3.9+) for your platform from [mamba documentation](https://mamba.readthedocs.io/en/latest/installation.html)
187184

188-
189-
2. Download the [NSIDC-Data-Tutorials](https://github.com/nsidc/NSIDC-Data-Tutorials) repository from Github by clicking the green 'Code' button located at the top right of the repository page and clicking 'Download Zip'. Unzip the file, and open a command line or terminal window in the NSIDC-Data-Tutorials folder's location.
185+
2. Download the [NSIDC-Data-Tutorials](https://github.com/nsidc/NSIDC-Data-Tutorials) repository from Github by clicking the green 'Code' button located at the top right of the repository page and clicking 'Download Zip'. Unzip the file, and open a command line or terminal window in the NSIDC-Data-Tutorials folder's location.
190186

191187
3. From a command line or terminal window, install the required environment with the following commands:
192188

193-
Linux
194-
```bash
195-
mamba create -n nsidc-tutorials --file binder/conda-linux-64.lock
196-
```
197-
198-
OSX
199189
```bash
200-
mamba create -n nsidc-tutorials --file binder/conda-osx-64.lock
201-
```
202-
203-
Windows
204-
```bash
205-
mamba create -n nsidc-tutorials --file binder/conda-win-64.lock
190+
mamba create -n nsidc-tutorials --file binder/conda-lock.yml
206191
```
207192

208193
You should now see that the dependencies were installed and our environment is ready to be used.
209194

210-
211195
Activate the environment with
212196

213197
```
@@ -222,14 +206,13 @@ jupyter lab
222206

223207
This should open a browser window with the JupyterLab IDE, showing your current working directory on the left-hand navigation. Navigate to the tutorial folder of choice and click on their associated *.ipynb files to get started.
224208

225-
226209
### Tutorial Environments
227210

228211
Although the nsidc-tutorial environment should run all the notebooks in this repository, we also include tutorial-specific environments that will only contain the dependencies for them. If we don't want to "pollute" our conda environments and we are only going to work with one of the tutorials we recommend to use them instead of the `nsidc-tutorial` environment. The steps to install them are exactly the same but the environment files are inside the environment folders in each of the tutorials. e.g. for ITS_LIVE
229212

230213
```bash
231214
cd notebooks/itslive
232-
mamba create -n nsidc-itslive --file environment/conda-linux-64.lock
215+
mamba create -n nsidc-itslive --file environment/conda-lock.yml
233216
conda activate nsidc-itslive
234217
jupyter lab
235218
```
@@ -238,7 +221,6 @@ This should create a pinned environment that should be fully reproducible across
238221

239222
> **NOTE:** Sometimes Conda environments change (break) even with pinned down dependencies. If you run into an issue with dependencies for the tutorials please open an issue and we'll try to fix it as soon as possible.
240223
241-
242224
## Credit
243225

244226
This software is developed by the National Snow and Ice Data Center with funding from multiple sources.

0 commit comments

Comments
 (0)