v1.0.1

Fixes and Maintenance

• Clean up code for the hutch-python launcher
• Fix issues with the test suite
• Fix issues with automatically loading ipython profiles

v1.0.0

API Breaks

• Swap to the newer psdm_qs_cli API for experiment loading that is
  compatible with commissioning experiment names.

v0.7.0

Features

• Add a ScanVars class for the legacy scan pvs tie-in.
• Automatically load all cameras defined in the camviewer config file.
• Add the --exp arg for forcing the active experiment for the duration
  of a session.

Bugfixes

• Exclude having a beampath when there are no devices on the path.
  This is because the resulting empty path causes issues in the
  environment. This will most commonly occur when calling
  hutch-python with no arguments.

v0.6.0

Features

• Provide well-curated namespaces for bluesky plans. These are in the
  shell as bp (bluesky plans) for normal plans, bps (bluesky plan
  stubs) for plans that are not complete on their own, and bpp
  (bluesky plan preprocessors) for plans that modify other plans.

Bugfixes

• Show a correct error message when there is an ImportError in an
  experiment file. This previously assumed the ImportError was from
  a missing experiment file. (#126)
• Prevent duplicate names in tree_namespace from breaking the tree.
  Show a relevant warning message. (#128)
• Do not configure the matplotlib backend for IPython if a user does not
  have a valid $DISPLAY environment variable. The most common case of this
  is if X-Forwarding is disabled. (#132)

v0.5.0

Bugfixes

• fix issue where importing hutchname.db could break under certain conditions
• fix issue where autocompleting a SimpleNamespace subclass would always have an extra mro() method, even though this is a class method not shared with instances.
• add logs folder to the hutch-python directory creator

Minor API break

• metadata_namespace -> renamed to tree_namespace (nobody imports this yet, but important enough to make this 0.5.0 instead of 0.4.1...)

v0.4.0

We've cleared the 0.4.0 milestone! It's time for a release.

Features Added

• elog object and posting
• load devices upstream from the hutch along the light path

Fixes

• Allow posting bug reports to github from the control room machines through the proxy
• Optimize the namespaces for faster loads and avoid a critical slowdown bug
• Make hutch banner as early as possible to avoid errant log messages in front of the banner
• Make cxi's banner red, as was intended
• hutch template automatically picks the latest environment, instead of hard-coding it

v0.3.0

Features Added:

• In-terminal bug reporting! See https://pcdshub.github.io/hutch-python/report.html. Operators will be able to report bugs directly to GitHub by using the report_bug function an IPython shell. This gathers log messages and environment information to help easily capture bug information in the field (#92)

%report_bug my_buggy_function()

• Port of the old python presets system. It works largely the same way, except the files are more readable and you can choose whether you want a preset to be permanent or just for an individual experiment experiment (#95):

my_motor.presets.add_hutch('important_pos', 32.4)
my_motor.presets.add_exp_here('sample')
my_motor.mv_sample()

• Objects from the questionnaire are included in the experiment object. (#84)
• Experiment object is always included, even without an experiment file, because of the previous point. (#84)

API Breaks:

• Daq platform map is no longer stored in-module. Hutches that want per-machine daq platform or a platform other than 0 need to include the new daq_platform section in their conf.yml. See https://pcdshub.github.io/hutch-python/yaml_files.html#daq-platform (#99)

Other Changes:

• qs.cfg renamed to web.cfg because it's not used only for the questionnaire. Backwards compatibility will be retained. (#91)

Bug Fixes:

• We are no longer creating 1-item metadata objects, as these are confusing and look wonky, e.g. safe_load will no longer spawn the safe.load name, unless we start adding other safe_ objects. (#85)
• db.txt is created in all-write mode (#94)

v0.2.1

• enable matplotlib in the IPython shell
• enable daqs with the correct platforms in all hutches
• suppress parso debug message
• update cookiecutter for upcoming release

v0.2.0

There has been a large rework since the last pre-release. The old conf.yml files probably no longer work. Utilities are provided to create hutch landing zones. Experiments can be selected automatically. The structure of the module is very different now, and it should be better. Future releases will have more specific release notes.

v0.1.0rc1

Workable hutch-python to be tried at mfx this week. There are still a lot of things to add or clean up. The module feels rushed at this point and we will lose some time going back to fix it, but that is okay.