Skip to content

Commit

Permalink
Cite hello world in installation checklist, generalize for queueserver (
Browse files Browse the repository at this point in the history
#279)

* MNT @241 suggested changes

* DOC #241 reference the Hello World! notebook
  • Loading branch information
prjemian authored Feb 26, 2024
1 parent 7d4f553 commit cb005db
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ New Features
Maintenance
------------

* Add 'Hello, World!' test to installation checklist.
* Drop the (unused now) *stdlogpj* package for configuring Python's *logging*.
* Environment for bluesky_2024_1.
* Updates (from learned 2-ID) for new installations.
Expand Down
4 changes: 2 additions & 2 deletions bluesky/user/quick_hello.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Hello, World! demo for bluesky-queueserver testing.
Demo 'Hello, World!' for testing, including bluesky-queueserver.
EXAMPLE::
Expand Down Expand Up @@ -41,4 +41,4 @@ class HelloDevice(Device):

def hello_world():
"""Simple bluesky plan for demonstrating Hello, World!."""
yield from bp.count([hello_device], md=dict(title="test QS"))
yield from bp.count([hello_device], md=dict(subtitle="test Bluesky"))
3 changes: 1 addition & 2 deletions docs/source/instrument/_install_new_instrument.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ to the documentation for each step.
#. `create conda environment <https://bcda-aps.github.io/bluesky_training/reference/_create_conda_env.html>`__
#. `configure IPython profile startup <https://bcda-aps.github.io/bluesky_training/reference/_ipython.html>`__
#. `configure bash with environment variable and alias <https://bcda-aps.github.io/bluesky_training/reference/_create_conda_env.html#create-an-alias-to-activate-the-bluesky-environment>`__
#. Verify the installation by running the `Hello, World! tutorial. <https://bcda-aps.github.io/bluesky_training/tutor/hello_world.html>`__
#. create soft link: ``ln -s ${HOME}/bluesky/blueskyStarter.sh ~/bin/``
#. Assign a MongoDB catalog for databroker: `instructions for BCDA <https://git.aps.anl.gov/bcda/bluesky-catalogs/-/blob/master/README.md>`__
#. `databroker catalog configuration <https://bcda-aps.github.io/bluesky_training/instrument/_configure_databroker.html#setup-your-databroker-catalog-configuration>`__
Expand Down Expand Up @@ -346,8 +347,6 @@ Note that the bluesky team recommends GitHub. (Why is that? See section
</ul>
The next steps are common to both web-based repositories (GitHub and GitLab):
- copy the remote `repository URL <https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#choosing-a-url-for-your-remote-repository>`_, for example,
Expand Down
4 changes: 3 additions & 1 deletion docs/source/instrument/_test_new_instrument.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Visit <a href=https://bcda-aps.github.io/bluesky_training/instrument/_install_ne

<details>
<summary>How to test my Bluesky installation?</summary>
Visit <a href=https://bcda-aps.github.io/bluesky_training/tutor/_hello_word.html> Hello World</a>.
Test (verify) the installation by running the <a
href=https://bcda-aps.github.io/bluesky_training/tutor/hello_world.html>Hello, World!</a>
tutorial.
</details>

<br>
Expand Down

0 comments on commit cb005db

Please sign in to comment.