Skip to content

Commit

Permalink
Minor documentation changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhjx1996 committed Jun 4, 2024
1 parent 992f96d commit f94594c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/Pythonic-DISORT.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@
"id": "fd874e5a",
"metadata": {},
"source": [
"**Installation**\n",
"**Installation and more examples of use**\n",
"\n",
"`pip install PythonicDISORT`\n",
"\n",
"See https://github.com/LDEO-CREW/Pythonic-DISORT for other options."
"See https://github.com/LDEO-CREW/Pythonic-DISORT for other installation options. See the Jupyter Notebooks in the `pydisotest` directory for more examples of use."
]
},
{
Expand Down
75 changes: 56 additions & 19 deletions pydisotest/3_test.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
"cell_type": "code",
"execution_count": null,
"id": "b2925dfb",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"import PythonicDISORT\n",
Expand All @@ -27,7 +29,9 @@
"cell_type": "code",
"execution_count": null,
"id": "dbacba8b",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"disort_is_installed = True\n",
Expand Down Expand Up @@ -83,7 +87,9 @@
"cell_type": "code",
"execution_count": null,
"id": "eaeaf144",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"######################################### PYDISORT ARGUMENTS #######################################\n",
Expand Down Expand Up @@ -117,7 +123,9 @@
"cell_type": "code",
"execution_count": null,
"id": "e21756a3",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"# Call pydisort function\n",
Expand All @@ -143,7 +151,9 @@
"cell_type": "code",
"execution_count": null,
"id": "cf7b5e45",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"# Reorder mu_arr from smallest to largest\n",
Expand All @@ -163,7 +173,9 @@
"cell_type": "code",
"execution_count": null,
"id": "7b8801dc",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"# Number of phi grid points\n",
Expand All @@ -187,7 +199,9 @@
"cell_type": "code",
"execution_count": null,
"id": "1bf8a9d2",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"# Stamnes' DISORT arguments\n",
Expand Down Expand Up @@ -246,7 +260,9 @@
"cell_type": "code",
"execution_count": null,
"id": "795dd2ef",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"if disort_is_installed:\n",
Expand Down Expand Up @@ -287,7 +303,9 @@
"cell_type": "code",
"execution_count": null,
"id": "b06865bd",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"(\n",
Expand All @@ -314,7 +332,9 @@
"cell_type": "code",
"execution_count": null,
"id": "e3b31888",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"assert np.max(ratio_flux_up[diff_flux_up > 1e-3], initial=0) < 1e-3\n",
Expand Down Expand Up @@ -347,7 +367,9 @@
"cell_type": "code",
"execution_count": null,
"id": "1af9251a",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"Nphi_plot = int((NQuad * pi) // 2) * 2 + 1\n",
Expand Down Expand Up @@ -407,7 +429,9 @@
"cell_type": "code",
"execution_count": null,
"id": "006fcb3e",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"######################################### PYDISORT ARGUMENTS #######################################\n",
Expand Down Expand Up @@ -441,7 +465,9 @@
"cell_type": "code",
"execution_count": null,
"id": "441b0638",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"# Call pydisort function\n",
Expand All @@ -467,7 +493,9 @@
"cell_type": "code",
"execution_count": null,
"id": "785e784e",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"# tau test points\n",
Expand All @@ -482,7 +510,8 @@
"metadata": {
"code_folding": [
0
]
],
"scrolled": false
},
"outputs": [],
"source": [
Expand Down Expand Up @@ -542,7 +571,9 @@
"cell_type": "code",
"execution_count": null,
"id": "5ad6bd31",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"if disort_is_installed:\n",
Expand Down Expand Up @@ -583,7 +614,9 @@
"cell_type": "code",
"execution_count": null,
"id": "3161d930",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"(\n",
Expand All @@ -610,7 +643,9 @@
"cell_type": "code",
"execution_count": null,
"id": "f385d558",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"assert np.max(ratio_flux_up[diff_flux_up > 1e-3], initial=0) < 1e-3\n",
Expand Down Expand Up @@ -643,7 +678,9 @@
"cell_type": "code",
"execution_count": null,
"id": "df01f944",
"metadata": {},
"metadata": {
"scrolled": false
},
"outputs": [],
"source": [
"Nphi_plot = int((NQuad * pi) // 2) * 2 + 1\n",
Expand Down

0 comments on commit f94594c

Please sign in to comment.