Skip to content

Commit

Permalink
DAS-1936 - Add requirements.txt file for documentation notebooks.
Browse files Browse the repository at this point in the history
  • Loading branch information
owenlittlejohns authored Oct 10, 2023
1 parent 2e52f52 commit 396ffd2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/HOSS_DAAC_Operator_Documentation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
"* [netCDF4](https://pypi.org/project/netCDF4/) - used by `xarray` to open NetCDF-4 files.\n",
"* [xarray](https://pypi.org/project/xarray/) - used to verify output\n",
"\n",
"Instructions to create a conda environment with these packages can be found in `docs/requirements.txt`.\n",
"\n",
"This notebook also assumes that an end-user has a `.netrc` file configured on their local machine, which should contain an entry for the Earthdata Login environment that will be used for test requests. Such an entry will look like:\n",
"\n",
"```\n",
Expand Down Expand Up @@ -419,7 +421,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.5"
"version": "3.11.6"
}
},
"nbformat": 4,
Expand Down
4 changes: 3 additions & 1 deletion docs/HOSS_User_Documentation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@
"$ pip install harmony-py\n",
"```\n",
"\n",
"Alternatively, follow the instructions in `docs/requirements.txt` to set up a conda environment that contains `harmony-py`.\n",
"\n",
"### Initial set-up\n",
"\n",
"The following cell imports standard classes from `harmony-py` and establishes a client to make requests to the UAT environment of Harmony. It also sets up two collection instances:\n",
Expand Down Expand Up @@ -325,7 +327,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.5"
"version": "3.11.6"
}
},
"nbformat": 4,
Expand Down
20 changes: 20 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#
# These requirements are used by the documentation Jupyter notebooks in the
# harmony-opendap-subsetter/docs directory.
#
# First create a conda or pyenv environment. To create a conda environment:
#
# conda create --name hoss-documentation python=3.11 --channel conda-forge -y
# conda activate hoss-documentation
#
# Then to install the dependencies:
#
# pip install -r docs/requirements.txt
#
# You should then be able to start a Jupyter notebook server and run both of
# the DAAC operator and end-user notebooks.
#
harmony-py~=0.4.10
netCDF4~=1.6.4
notebook~=7.0.4
xarray~=2023.9.0

0 comments on commit 396ffd2

Please sign in to comment.