Skip to content

Commit f12a90d

Browse files
authored
Merge pull request #12 from akpetty/master
update readme
2 parents c585148 + 65893c4 commit f12a90d

1 file changed

Lines changed: 29 additions & 10 deletions

File tree

07_SeaIce_Petty/README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,51 @@ Earth image illustrating AMSR-E sea ice courtesy of the NASA Scientific Visualiz
77

88
## Setup
99

10-
This GitHub repository primarily hosts the Jupyter Notebooks needed for the hackweek tutorials. The notebooks should work without any extra steps if you're working in the ICESat-2 Pangeo environment that has been created for this hackweek. Just clone this repository into your Pangeo user account (git clone https://github.com/akpetty/ICESat2_hackweek_tutorials/07_SeaIce_Petty when logged in). To run the notebooks on your local machine instead, a conda environment file (is2seaiceenv_environment.yml) has been provided in this repo for you to generate a Python environment that includes all the revelant libraries you might need:
10+
This GitHub repository primarily hosts the Jupyter Notebooks needed for the hackweek tutorials. The notebooks should work without any extra steps if you're working in the ICESat-2 Pangeo environment that has been created for this hackweek. Just clone the hackweek repo into your Pangeo user account (git clone https://github.com/akpetty/ICESat2_hackweek_tutorials when logged in).
11+
12+
To run the notebooks on your local machine, you can also just run git clone to grab everything, then cd into the sea ice subdirectory (cd 07_SeaIce_Petty)
13+
```
14+
git clone https://github.com/akpetty/ICESat2_hackweek_tutorials
15+
cd 07_SeaIce_Petty
16+
```
17+
NB If running on your local machine you need to grab/clone the entire repo so you have access to the reader and utils libraries!
18+
19+
A conda environment file (is2seaiceenv_environment.yml) has been provided in this repo for you to generate a Python environment that includes all the revelant libraries you might need:
1120
```
1221
conda env create -f is2seaiceenv_environment.yml
1322
```
1423

1524
If this doesn't work you can try generating your own Python 3.7 conda environment that includes the packages we need (sometimes there are issues getting environment files like this working across mac/pc/linux platforms):
1625
```
17-
conda create -n is2env python=3.7 basemap xarray pandas netcdf4 pyproj scipy matplotlib h5py seaborn cartopy
26+
conda create -n is2env python=3.7 basemap xarray pandas netcdf4 pyproj scipy matplotlib h5py seaborn cartopy s3fs astropy
1827
```
1928

2029
The hackweek includes extra tutorials on conda (and miniconda) so see those resources for more information.
2130

22-
The example data files are being stored on a Pangeo Amazon S3 data server. The notebooks incuded here provide a call you can run to quickly download these files to your Data directory. A gitignore file is included to ignore these hdf5 (.h5) files if you decide to fork this repo and push any local changes.
31+
The example data files are being stored on a Pangeo Amazon S3 data server. The notebooks incuded here provide a call you can run to quickly download these files to your Data directory IF YOU'RE RUNNING THIS ON THE PANGEO SERVERS. A gitignore file is included to ignore these hdf5 (.h5) files if you decide to fork this repo and push any local changes.
32+
33+
If you want to grab this data outside ON YOUR LOCAL MACHINE you will need the aws client installed on your machine. For mac this can be done using pip:
34+
```
35+
pip install awscli
36+
```
2337

24-
If you want to do this outside of the notebooks you can run the following commands from the terminal to get the data you need:
38+
You can run the following commands from the terminal to get the data you need:
2539
```
26-
cp Data
27-
aws s3 cp s3://pangeo-data-upload-oregon/icesat2/ATL07-01_20181115003141_07240101_001_01.h5 .
28-
aws s3 cp s3://pangeo-data-upload-oregon/icesat2/ATL03_20181115022655_07250104_001_01.h5 .
40+
cd Data
41+
aws --no-sign-request s3 cp s3://pangeo-data-upload-oregon/icesat2/ATL07-01_20181115003141_07240101_001_01.h5 .
42+
43+
aws --no-sign-request s3 cp s3://pangeo-data-upload-oregon/icesat2/ATL03_20181115022655_07250104_001_01.h5 .
44+
45+
aws --no-sign-request s3 cp s3://pangeo-data-upload-oregon/icesat2/ATL10-01_20181115003141_07240101_001_01.h5 .
46+
2947
```
30-
and examples of how to upload data to S3:
48+
and examples of how to upload data to S3 if you need to for some reason:
3149

3250
```
33-
aws s3 cp ATL03_20181115022655_07250104_001_01.h5 s3://pangeo-data-upload-oregon/icesat2/
34-
aws s3 cp ATL07-01_20181115003141_07240101_001_01.h5 s3://pangeo-data-upload-oregon/icesat2/
51+
aws --no-sign-requests 3 cp ATL03_20181115022655_07250104_001_01.h5 s3://pangeo-data-upload-oregon/icesat2/
52+
aws --no-sign-request s3 cp ATL07-01_20181115003141_07240101_001_01.h5 s3://pangeo-data-upload-oregon/icesat2/
3553
```
54+
If you're stil struggling to get the data feel free to email me (alek.a.petty@nasa.gov) and I can give you a link.
3655

3756
Good luck!
3857

0 commit comments

Comments
 (0)