"configure" - WEAVE field-configuration tool
Welcome to the webpage for the "configure" software. Please note that this page is currently intended for use only by open-time PIs.
Before WEAVE is open to open-time PIs, configure will be made publicly available with relevant guidance and support.
No support will be provided for configure for PIs of SV projects at this stage.
What is configure?
In a nutshell, configure is the software that allows us to configure fields to be observed by WEAVE, i.e., to allocate fibres to objects for a particular WEAVE field.
The configure software is written by David Terrett.
Where can I run configure?
A general configure user should download the latest version of configure and run this on their own machine.
Download configure
To identify the version you are running, run configure with the --version command line option and the version number will be printed on standard out. For macOS, after moving the app to Applications, run /Applications/configure.app/Contents/MacOS/configure --version.
| latest configure version number | date released | linux | mac |
|---|---|---|---|
3.3.2 | 5 April 2022 | ||
3.3.4 | 21 June 2022 | configure_3.3.4.dmg (macOS ≥11.0) configure_3.3.4-Catalina.dmg (macOS 10.15 - caveat emptor: not yet tested) | |
3.3.5 Corrects the mapping of positioner x/y to the sky (it was rotated by 180 degrees). The mapping has now been verified on sky. | 13 July 2022 | ||
3.3.6 | 14 September 2022 | This version should run on MacOS 10.15 or later | |
3.3.11 Updated test version for workflow testing – this is the release candidate for 3.4 New configure option --enable_fibre_catagory. This version is built with fibre status's matching the current state of the positioner which means that many fibres that are due to be repaired soon are disabled. The --enable_fibre_catagory option allows fibres that are disabled for a specific reason to be enabled. The catagories due for repair are "Bad Ferrule" and "No Magnet". To enable them use: configure --enable "bad ferrule" --enable "no magnet" | 23 February 2023 | ||
3.4
| 10 March 2023 | ||
3.4.1 Fixes a bug in --enable. Only effects MOS mode; v3.4 configurations are valid but won't have as many allocated fibres as they should. | 21 March 2023 | ||
3.4.5 The collisions disgnostics are now just produced when the "Check" button is pressed but now includes details of which fibres the positioner would chose to park. List of disabled fibres updated. Use this version for MOS Science Verification | 26 June 2023 | ||
3.4.6 "configure --max_runtime n" kills the configure command line process after n seconds (with exit status 2). n=0 (the default) disables this feature. This is a workaround for the occasional infinite loop in the sky search phase. List of disabled fibres updated. Notes 4 September:
| 02 August 2023 | ||
3.4.7 List of disabled fibres updated. | 28 November 2023 |
As of version 3.0.0 the input XML must specify the data model version. Old XMLs can be fixed so that configure doesn't complain by adding datamver="8.00" as an attribute of the root element. However, note that old XMLs are not guaranteed to produce the same output, as (1) configure is regularly updated with new information about the fibres and (2) configuration is an intrinsically random process.
Documentation
| configure documentation | date | more information | downloadable document |
|---|---|---|---|
| user manual | 31 Mar 2020 | ||
configure XML definition | 29 April 2020 | - document describing format of input field definition - specifies what configure and the positioner software requires (with the exception of quality assessment criteria) |
LIFU fields
configure_lifu is an analogue of configure for creating XML descriptions of LIFU observations. It reads an input file that looks like a input to configure except that it only contains one target and doesn't contain most of the stuff needed by configure to drive the confiuration process. All it does is update the field centre to match the target and generates new targets for each of the remaining LIFU fibres. The intent is that LIFU observations have an XML description that is sufficiently close to that for a MOS field that they can be treated in the same way for much of the rest of the dataflow.
The program is command line only and has -f and -o command line options for specifying the names of the input and output files.
Here are example input (lifuField.xml) and (lifuConfig.xml) files. (These use the "new" attributes - "targra" instead of "RA_D" etc. etc.)
The dither program is also needed if you plan to dither your LIFU observations.
Here's a typical run of these two programs (and xmllint for checking the xml):
% lifu_configure --epoch 2020 -i output/WC_2021A1-lifu_01-tgc.xml -o output/WC_2021A1-lifu_01-tgcs-tmp-orig.xml % dither -i output/WC_2021A1-lifu_01-tgcs-tmp-orig.xml -o output/WC_2021A1-lifu_01-tgcs-orig.xml % xmllint --c14n output/WC_2021A1-lifu_01-tgcs-orig.xml | xmllint --format --encode utf-8 --output output/WC_2021A1-lifu_01-tgcs.xml -