search

BCDA-APS / bluesky_training

Bluesky training, including instrument package
https://bcda-aps.github.io/bluesky_training/
Other
11 stars 0 forks source link

DOC IPython instructions need more details #197

Open prjemian opened 1 year ago

prjemian commented 1 year ago

These instructions need more detail. As they appear now, they show the resulting file structure.

rodolakis commented 1 year ago

There are already instruction to create a python profile in the new instrument installation documentation:

https://bcda-aps.github.io/bluesky_training/instrument/_install_new_instrument.html#create-a-bluesky-ipython-profile

prjemian commented 1 year ago

The instruction to create a new ipython profile: ipython profile create bluesky --ipython-dir="~/.ipython" should use an environment variable to specify which directory. The instructions to be removed define the wrong environment variable. The correct version should be:

export IPYTHON_DIR=~/.ipython
# export IPYTHON_DIR=~/.ipython-bluesky  # an alternative
mkdir -p "${IPYTHON_DIR}"
ipython profile create bluesky --ipython-dir="${IPYTHON_DIR}"

The expected definition of BLUESKY_DIR is the location of the directory containing the instrument package. Typically:

export BLUESKY_DIR=~/bluesky