diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index b37b1e9072efb78fe963d277446fef32a6a715db..0000000000000000000000000000000000000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. autosummary:: - :toctree: generated - - dartwrf - diff --git a/docs/source/dartwrf.rst b/docs/source/dartwrf.rst index c01ca5f05b67bd11049bc8b1d4c8f04945cc392e..d358f3262df76cbb6431638bc4d8ee4c9fcd0e5d 100644 --- a/docs/source/dartwrf.rst +++ b/docs/source/dartwrf.rst @@ -13,6 +13,14 @@ Subpackages Submodules ---------- +dartwrf.workflows module +------------------------ + +.. automodule:: dartwrf.workflows + :members: + :undoc-members: + :show-inheritance: + dartwrf.assim\_synth\_obs module -------------------------------- @@ -141,14 +149,6 @@ dartwrf.utils module :undoc-members: :show-inheritance: -dartwrf.workflows module ------------------------- - -.. automodule:: dartwrf.workflows - :members: - :undoc-members: - :show-inheritance: - dartwrf.wrfinput\_add\_geo module --------------------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 282d53b1981bab76a8af373faf6898a4d823a89a..251bf42ee787509d873eb4d790c533352b0d291e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -29,12 +29,19 @@ Other helpful resources .. toctree:: :maxdepth: 2 - :caption: Tutorials: + :caption: Tutorials notebooks/tutorial1 notebooks/tutorial2 notebooks/tutorial3 - + +.. toctree:: + :hidden: + :caption: Reference + + modules + genindex + API === @@ -42,5 +49,3 @@ API * :ref:`genindex` * :ref:`modindex` * :ref:`search` - - diff --git a/docs/source/modules.rst b/docs/source/modules.rst index d2417a80236590c7d565d3c2f36e15d0fa95cfdc..a514a2a3890d57ba0b4ca96cef8b5afe6e39ffb3 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -1,5 +1,5 @@ -dartwrf -======= +API Reference +============= .. toctree:: :maxdepth: 4 diff --git a/docs/source/notebooks/tutorial2.ipynb b/docs/source/notebooks/tutorial2.ipynb index 56751a09aa6fcc22d1ed60d163753d1051e6493f..e10f786f2245c7334dbb6c081cf26a35d57dbb18 100644 --- a/docs/source/notebooks/tutorial2.ipynb +++ b/docs/source/notebooks/tutorial2.ipynb @@ -24,11 +24,11 @@ "\n", "It is necessary to set the path to the prepared WRF input soundings in `config/cfg.py` like this\n", "```python\n", - "exp.input_profile = '/user/test/data/initial_profiles/wrf/ens/raso.fc.<iens>.wrfprof'\n", + "exp.input_profile = '/users/students/lehre/advDA_s2023/data/initial_profiles/raso.fc.<iens>.wrfprof'\n", "```\n", "where `<iens>` is a placeholder, since there is one file for each member, from `raso.fc.001.wrfprof` to `raso.fc.040.wrfprof`.\n", "\n", - "Then, we set up the workflows as usual and prepare the input profiles using `prepare_WRFrundir`.\n", + "Then, we set up the workflows as usual and prepare the input profiles.\n", "```python\n", "import datetime as dt\n", "from dartwrf.workflows import WorkFlows\n", @@ -78,13 +78,13 @@ "\n", "1. Prepare initial conditions from a prior forecast:\n", "```python\n", - "id = w.prepare_IC_from_prior(prior_path_exp, prior_init_time, prior_valid_time, depends_on=id)\n", + "w.prepare_IC_from_prior(prior_path_exp, prior_init_time, prior_valid_time)\n", "```\n", "\n", "\n", "2. Update the initial conditions from data assimilation:\n", "```python\n", - "id = w.update_IC_from_DA(time, depends_on=id)\n", + "w.update_IC_from_DA(time)\n", "```\n", "\n", "After this, the wrfrst files are updated with assimilation increments from DART output and copied to the WRF's run directories so you can continue to run the forecast ensemble.\n", @@ -107,7 +107,7 @@ "timedelta_btw_assim = dt.timedelta(minutes=15)\n", "output_restart_interval = timedelta_btw_assim.total_seconds()/60\n", "\n", - "id = w.run_ENS(begin=time, # start integration from here\n", + "w.run_ENS(begin=time, # start integration from here\n", " end=time + timedelta_integrate, # integrate until here\n", " output_restart_interval=output_restart_interval\n", " )\n",