Skip to content

Commit a732040

Browse files
committed
docs: simplify radas instructions
1 parent 6050f4a commit a732040

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

docs/doc_sources/Usage.rst

+5-8
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,18 @@ The cfspopcon package is available on the `Python Package Index <https://pypi.or
1111
.. code::
1212
1313
>>> pip install cfspopcon
14-
1514
.. warning::
16-
The :code:`cfspopcon.atomic_data` module requires data files produced by the `radas project <https://github.com/cfs-energy/radas>`_. Radas produces these files by processing `OpenADAS <https://open.adas.ac.uk/adf11>`_ 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).
15+
The :code:`cfspopcon.atomic_data` module requires data files produced by the `radas project <https://github.com/cfs-energy/radas>`_. Radas produces these files by processing `OpenADAS <https://open.adas.ac.uk/adf11>`_ 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.
1716

1817
.. code:: bash
19-
18+
2019
>>> export RADAS=$(python -c "from cfspopcon import atomic_data;from pathlib import Path; print(Path(atomic_data.__file__).parent)")
21-
>>> pushd /tmp
2220
>>> git clone https://github.com/cfs-energy/radas.git
2321
>>> pushd radas
24-
>>> poetry install --only main
25-
>>> poetry run fetch_adas
26-
>>> poetry run run_radas
22+
>>> PYTHONPATH=$PWD:$PYTHONPATH python adas_data/fetch_adas_data.py
23+
>>> PYTHONPATH=$PWD:$PYTHONPATH python run_radas.py
2724
>>> cp ./cases/*/output/*.nc $RADAS
28-
>>> popd && popd
25+
>>> popd
2926
3027
3128
Example Notebook

0 commit comments

Comments
 (0)