Skip to content

Commit

Permalink
DOC #295 point to next steps
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Apr 10, 2024
1 parent f67aa5e commit b4f2913
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 14 deletions.
25 changes: 13 additions & 12 deletions docs/source/instrument/_configure_bluesky_instrument.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@ Configure bluesky instrument
After the steps in the "ref"`checklist` are complete, it is time to configure
the instrument for the details of this specific user.

Settings for various aspects of data collection are distributed amongst
the many directories and files of the ``instrument/`` subdirectory. We
call this directory the ``instrument`` package (it is configured as a
Python package for use by an ``import`` statement). See this
`advice <./_configure_bluesky_instrument.md>`__ for configuration of the
``instrument`` package.

The ``instrument/iconfig.yml``
`file <../../../bluesky/instrument/iconfig.yml>`__ gathers these many
configurations into one location, easily found in the root directory of
the ``instrument`` package. The definitions in this file are easily
(re)configured.
Settings for various aspects of data collection are distributed amongst the many
directories and files of the ``instrument/`` subdirectory. This directory is
configured as a Python `package
<https://realpython.com/python-modules-packages/>`_ so that it can be loaded
with an ``import`` `statement <https://www.askpython.com/python/python-import-statement>`_, such as:

from instrument.collection import *

The `file <../../../bluesky/instrument/iconfig.yml>`__
``instrument/iconfig.yml`` gathers many common configuration details
into one location (in the root directory of the ``instrument``
package). This is a text file in `YAML <https://yaml.org>`_ format. It's easy
to edit with any text editor.

Initial configuration of the instrument
---------------------------------------
Expand Down
6 changes: 4 additions & 2 deletions docs/source/instrument/install_new_instrument.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ to the documentation for each step.

.. TODO: resolve confusing mismatch in names (like step 1)
Could move each section to its own file.
Then point to the next steps.
#. :ref:`instrument.create_bluesky_directory`
#. :ref:`reference.create_bluesky_enviroment`
Expand All @@ -28,9 +27,12 @@ to the documentation for each step.
#. :ref:`instrument.test_new_instrument`
#. create soft link: ``ln -s ${HOME}/bluesky/blueskyStarter.sh ~/bin/``
#. :ref:`instrument.setup_catalog_configuration`
#. :ref:`instrument.configure_bluesky_instrument`
#. :ref:`instrument.start_vc`

After these steps are complete, it is time to configure
the instrument for the details of this specific user.
See the :ref:`instrument.configure_bluesky_instrument` section next.

.. _instrument.create_bluesky_directory:

Create bluesky directory
Expand Down

0 comments on commit b4f2913

Please sign in to comment.