From a732040b314679ab5cf8f0d518729c24d1618c58 Mon Sep 17 00:00:00 2001 From: Christoph Hasse Date: Mon, 6 Nov 2023 18:51:55 -0500 Subject: [PATCH] docs: simplify radas instructions --- docs/doc_sources/Usage.rst | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/doc_sources/Usage.rst b/docs/doc_sources/Usage.rst index ad80ef6d..357911f1 100644 --- a/docs/doc_sources/Usage.rst +++ b/docs/doc_sources/Usage.rst @@ -11,21 +11,18 @@ The cfspopcon package is available on the `Python Package Index >> pip install cfspopcon - .. warning:: - The :code:`cfspopcon.atomic_data` module requires data files produced by the `radas project `_. Radas produces these files by processing `OpenADAS `_ data. These files are not shipped as part of :code:`cfspopcon`. Follow the below steps after the :code:`pip install cfspopcon` command (we will try to make this smoother in the future. N.b. this only has to be done once). + The :code:`cfspopcon.atomic_data` module requires data files produced by the `radas project `_. Radas produces these files by processing `OpenADAS `_ data. These files are not shipped as part of :code:`cfspopcon`, thus the below steps need to be run once after installing :code:`cfspopcon`. Please follow the below instructions from within the python environement :code:`cfspopcon` is installed into. .. code:: bash - + >>> export RADAS=$(python -c "from cfspopcon import atomic_data;from pathlib import Path; print(Path(atomic_data.__file__).parent)") - >>> pushd /tmp >>> git clone https://github.com/cfs-energy/radas.git >>> pushd radas - >>> poetry install --only main - >>> poetry run fetch_adas - >>> poetry run run_radas + >>> PYTHONPATH=$PWD:$PYTHONPATH python adas_data/fetch_adas_data.py + >>> PYTHONPATH=$PWD:$PYTHONPATH python run_radas.py >>> cp ./cases/*/output/*.nc $RADAS - >>> popd && popd + >>> popd Example Notebook