Skip to content

Commit

Permalink
docs: simplify radas instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
hassec committed Nov 7, 2023
1 parent 6050f4a commit a732040
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions docs/doc_sources/Usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,18 @@ The cfspopcon package is available on the `Python Package Index <https://pypi.or
.. code::
>>> pip install cfspopcon
.. warning::
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).
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.

.. 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
Expand Down

0 comments on commit a732040

Please sign in to comment.