Skip to content

Commit

Permalink
updates to docs with es token reminder
Browse files Browse the repository at this point in the history
  • Loading branch information
timdittmann committed Aug 28, 2023
1 parent 4e7b9ba commit 6416b45
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ sphinx:
configuration: docs/conf.py

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats: all
formats:
- pdf

#python:
# Install our python package before building the docs
Expand Down
2 changes: 2 additions & 0 deletions docs/homeworks/homework0.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
There are two versions of this homework: a Jupyter Notebook version and a command line version.
Pick the method that you prefer to do your analysis in the course, or experiment with both.

To access Earthscope data, [an account is required](https://data-idm.unavco.org/user/profile/login).

## **Jupyter Notebook version:**

run the [HW0 notebook](https://www.unavco.org/gitlab/gnss_reflectometry/gnssrefl_jupyter/-/blob/master/notebooks/learn-the-code/part_0.ipynb) from the [jupyter notebook repository, either via docker or to clone and run locally on your machine](https://www.unavco.org/gitlab/gnss_reflectometry/gnssrefl_jupyter).
Expand Down
12 changes: 7 additions & 5 deletions docs/pages/docker_cl_instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ More information on [getting started, testing your installation, and developing.

## Run gnssrefl Docker

Reminder: If you want to process EarthScope data, you will need to create [an EarthScope profile.](https://data.unavco.org/user/profile/info)
Reminder: If you want to process EarthScope data, you will need to create [an EarthScope profile.](https://data.unavco.org/user/profile/info).

change directory into the local directory that you wish to keep your processed results

Expand All @@ -33,7 +33,13 @@ Description of the commands used:

Now you can start working with the [gnssrefl code.](https://github.com/kristinemlarson/gnssrefl#understanding)

### Update Docker Image to newest version <a name="Update Docker"></a>

`docker pull ghcr.io/kristinemlarson/gnssrefl:latest`

### Notes:
The first time you run this container from a specific path, the Earthscope token will be installed once in the container at `` and locally at `/localpath_of_dockerrun/refl_zones` (the volume you mounted with the `-v` command)

docker has vim for editing text files (ie .json station config file)

When running the software in the docker, plots/files will **not** print to the screen (think quickLook or daily_average utilities), but will be stored on the local machine in the directory that the docker run command was issued.
Expand All @@ -60,10 +66,6 @@ If you need to see the container(s) you have running you can use `docker ps`

If you need to see all container(s) you can use `docker container ls -a`

### Update Docker Image to newest version <a name="Update Docker"></a>

`docker pull ghcr.io/kristinemlarson/gnssrefl:latest`


## For WINDOWS USERS:
(thank you Paul Wu and James Monaco @ Univ. of CO for this)
Expand Down

0 comments on commit 6416b45

Please sign in to comment.