BCDA-APS / use_bluesky

Tools to help APS use the Bluesky Framework (https://blueskyproject.io/)
8 stars 3 forks source link

broken links #97

Closed prjemian closed 3 years ago

prjemian commented 3 years ago

@jkirchman reports by email:

I noticed a couple of broken links on the "Bluesky at the APS" webpage (https://www.aps.anl.gov/BCDA/Bluesky).

prjemian commented 3 years ago

master is the old default branch, now it's main

prjemian commented 3 years ago
(base) prjemian@zap:~/Documents/projects/BCDA-APS/use_bluesky$ git grep nsls-ii | grep tutorial
lessons/lesson1.ipynb:    "So far, we have used ophyd to talk with the EPICS scaler.  Let's start to use Bluesky.  We need to load support to start the Bluesky [*RunEngine*](http://nsls-ii.github.io/bluesky/tutorial.html#the-runengine).  For now, we'll use the most basic configuration (does not save data anywhere).  \n",
prjemian commented 3 years ago

Also need to check for any legacy references to nsls-ii:

(base) prjemian@zap:~/Documents/projects/BCDA-APS/use_bluesky$ git grep nsls-ii
lessons/lesson1.ipynb:    "In this lesson, we'll work with a scaler (devices that counts pulses emitted from one or more pulse-emitting ***detector*** electronics) and use this to make a first lesson in using [Bluesky](http://nsls-ii.github.io/bluesky/) and [related tools](http://nsls-ii.github.io/).\n",
lessons/lesson1.ipynb:    "First, we'll show how to start a Jupyter notebook.  Next, we'll connect with an EPICS scaler (using [ophyd](http://nsls-ii.github.io/ophyd/)), and then use the Bluesky software to count from the scaler.\n",
lessons/lesson1.ipynb:    "The scaler is `sky:scaler1`.  We'll connect to that first.  To make the connection, we need to import the [`ScalerCH`](http://nsls-ii.github.io/ophyd/builtin-devices.html#epicsscaler) device from the [`ophyd.scaler`](http://nsls-ii.github.io/ophyd/) library."
lessons/lesson1.ipynb:    "Since `scaler.preset_time` is an [`EpicsSignal`](https://github.com/NSLS-II/ophyd/blob/master/ophyd/signal.py#L647), ([Signal](http://nsls-ii.github.io/ophyd/signals.html) is a fundamental ophyd structure), we print its `.value`."
lessons/lesson1.ipynb:    "So far, we have used ophyd to talk with the EPICS scaler.  Let's start to use Bluesky.  We need to load support to start the Bluesky [*RunEngine*](http://nsls-ii.github.io/bluesky/tutorial.html#the-runengine).  For now, we'll use the most basic configuration (does not save data anywhere).  \n",
lessons/lesson1.ipynb:    "The job of the RunEngine is to process command messages (our data acquisition commands) and to output documents (the data to be acquired).  Initially, we'll use predefined data acquisition sequences (called [*plans*](http://nsls-ii.github.io/bluesky/plans.html)) and ignore the [documents](http://nsls-ii.github.io/bluesky/documents.html)."
lessons/lesson1.ipynb:    "Next, we'll load a library with many [predefined plans](http://nsls-ii.github.io/bluesky/plans.html#summary).  The first plan we want to use is [`count()`](http://nsls-ii.github.io/bluesky/generated/bluesky.plans.count.html#bluesky.plans.count).  By the way, we'll use a python feature to rename `bluesky.plans` to the shorter `bp` since it will be used a lot."
lessons/lesson1.ipynb:    "So, there were four documents.  See http://nsls-ii.github.io/bluesky/documents.html for the details of each.  Let's extend our callback to print the details of each."
lessons/lesson2.ipynb:    "In this lesson, we'll work with a motor (for precise positioning) in [Bluesky](http://nsls-ii.github.io/bluesky/) and [related tools](http://nsls-ii.github.io/).\n",
lessons/lesson2.ipynb:    "First, we'll connect with an EPICS motor (using [ophyd](http://nsls-ii.github.io/ophyd/)), and then use the Bluesky software to scan the motor (with the scaler from [lesson 1](lesson1.ipynb)).\n",
lessons/lesson3.ipynb:    "The [simplest example of a Bluesky callback](http://nsls-ii.github.io/bluesky/callbacks.html#simplest-working-example) is the `print` function.  We want a callback function that understands our data and uses reasonable assumptions to show that data as it is being acquired.\n",
lessons/lesson3.ipynb:    "One method to display our data is in a [table](http://nsls-ii.github.io/bluesky/callbacks.html#livetable) that updates as the scan progresses.  We'll import the `LiveTable` callback from the Bluesky library:"
lessons/lesson3.ipynb:    "There is a callback routine that will plot the data as it is acquired.  When starting graphics, it is necessary to first initialize the graphics manager of the display.  The setup is specific to the graphics manager.  For command line or python program use, see http://nsls-ii.github.io/bluesky/callbacks.html#aside-making-plots-update-live.\n",
lessons/lesson3.ipynb:    "Both the table and the plot are very useful diagnostics for routine use.  They have been combined in the [*Best-Efforts Callback*](http://nsls-ii.github.io/bluesky/callbacks.html#best-effort-callback) which provides best-effort plots and visualization for any plan.  It uses [user-configurable information](http://nsls-ii.github.io/bluesky/callbacks.html#hints) that is part of every ophyd device to make reasonable assumptions about what information is appropriate to display in the context of the current plan.\n",
lessons/sandbox/flyer_template.ipynb:    "In BlueSky, a [Flyer](http://nsls-ii.github.io/bluesky/async.html?highlight=flyer#flying) is an `ophyd.Device` that meets the Flyer interface, which has three methods:\n",
lessons/sandbox/flyer_template.ipynb:    "The first two methods [must return](http://nsls-ii.github.io/bluesky/hardware.html?highlight=flyer#kickoff) an instance of `ophyd.DeviceStatus` (a.k.a. a *status* object).  \n",
lessons/sandbox/sscan_as_Flyer.ipynb:    "Use the [sscan record](https://epics.anl.gov/bcda/synApps/sscan/sscanRecord.html) as an [ophyd Flyer](http://nsls-ii.github.io/bluesky/async.html) for [bluesky](http://nsls-ii.github.io/bluesky) data acquisition.  Consider the case of [1D step scans using sscan record](https://epics.anl.gov/bcda/synApps/sscan/sscanRecord.html#HEADING_1-1)."
lessons/sandbox/sscan_as_Flyer.ipynb:    "        # http://nsls-ii.github.io/ophyd/generated/ophyd.flyers.FlyerInterface.kickoff.html\n",
lessons/sandbox/sscan_as_Flyer.ipynb:    "        # http://nsls-ii.github.io/ophyd/generated/ophyd.flyers.FlyerInterface.complete.html\n",
lessons/sandbox/sscan_as_Flyer.ipynb:    "        # http://nsls-ii.github.io/ophyd/generated/ophyd.flyers.FlyerInterface.describe_collect.html\n",
lessons/sandbox/sscan_as_Flyer.ipynb:    "        # http://nsls-ii.github.io/ophyd/generated/ophyd.flyers.FlyerInterface.collect.html\n",
lessons/sandbox/working_with_area_detector_image_data.ipynb:    "Following these instructions from NSLS2:  http://nsls-ii.github.io/databroker/assets.html"
prjemian commented 3 years ago

@jkirchman : correct link to tutorials is: https://blueskyproject.io/tutorials/

prjemian commented 3 years ago

@jkirchman: Thanks for reporting this. Both links have been fixed on BCDA's web site (source is outside of this repository).