| Name | hxrsnd JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | Python controls suite for HXRSnD |
| upload_time | 2023-07-26 21:28:37 |
| maintainer | |
| docs_url | None |
| author | SLAC National Accelerator Laboratory |
| requires_python | >=3.9 |
| license | Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. (3) Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, THE UNITED STATES GOVERNMENT, OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to SLAC National Accelerator Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such Enhancements or derivative works thereof, in binary and source code form. |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
====================================================================
Welcome to the Hard X-Ray Split and Delay Automated Controls System!
====================================================================
.. image:: https://travis-ci.org/pcdshub/hxrsnd.svg?branch=master
:target: https://travis-ci.org/pcdshub/hxrsnd
.. image:: https://landscape.io/github/pcdshub/hxrsnd/master/landscape.svg?style=flat
:target: https://landscape.io/github/pcdshub/hxrsnd/master
Controls automation module for the hard x-ray split and delay instrument.
Getting Started
===============
The easiest way to start using the hard x-ray split and delay is to navigate to
the released area which has everything setup. From any of the LCLS NFS machines
that can view XCS PVs, run the following to change to the correct directory: ::
$ cd /reg/neh/operator/xcsopr/bin/snd
From here, all the core functionality of the split and delay system can be
accessed.
Running the IPython Shell
-------------------------
The most common used way to interface with the system is through the ``IPython``
shell. From the top level SnD directory listed above, run the following launcher
script: ::
$ ./run_snd
The shell will have all the SnD objects instantiated and ready for use.
.. note:: This is a softlink to the launcher script which lives in
``bin/``
Instrument Screens
------------------
There is a system level EDM screen that has all the motors and pneumatics. To
launch the screen, run the following launcher sript from the directory listed
above: ::
$ ./snd_main
.. note:: This is a softlink to the launcher script which lives in
``hxrsnd/screens/``
To view diode correlation plots, run the following launcher script from the
directory listed above: ::
$ ./show_diodes.sh
Raw data
{
"_id": null,
"home_page": "",
"name": "hxrsnd",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "SLAC National Accelerator Laboratory",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/85/6b/9bd56a204f808eaa377d4f5ac84ed56aee0c75a414f22b146d73729970da/hxrsnd-0.3.1.tar.gz",
"platform": null,
"description": "====================================================================\nWelcome to the Hard X-Ray Split and Delay Automated Controls System!\n====================================================================\n.. image:: https://travis-ci.org/pcdshub/hxrsnd.svg?branch=master\n :target: https://travis-ci.org/pcdshub/hxrsnd\n\n.. image:: https://landscape.io/github/pcdshub/hxrsnd/master/landscape.svg?style=flat\n :target: https://landscape.io/github/pcdshub/hxrsnd/master\n\nControls automation module for the hard x-ray split and delay instrument.\n\nGetting Started\n===============\n\nThe easiest way to start using the hard x-ray split and delay is to navigate to\nthe released area which has everything setup. From any of the LCLS NFS machines\nthat can view XCS PVs, run the following to change to the correct directory: ::\n\n $ cd /reg/neh/operator/xcsopr/bin/snd\n\nFrom here, all the core functionality of the split and delay system can be\naccessed.\n\nRunning the IPython Shell\n-------------------------\n\nThe most common used way to interface with the system is through the ``IPython``\nshell. From the top level SnD directory listed above, run the following launcher\nscript: ::\n\n $ ./run_snd\n\nThe shell will have all the SnD objects instantiated and ready for use.\n\n.. note:: This is a softlink to the launcher script which lives in\n ``bin/``\n\nInstrument Screens\n------------------\n\nThere is a system level EDM screen that has all the motors and pneumatics. To\nlaunch the screen, run the following launcher sript from the directory listed\nabove: ::\n\n $ ./snd_main\n\n.. note:: This is a softlink to the launcher script which lives in\n ``hxrsnd/screens/``\n\nTo view diode correlation plots, run the following launcher script from the\ndirectory listed above: ::\n\n $ ./show_diodes.sh\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023, The Board of Trustees of the Leland Stanford Junior University, through SLAC National Accelerator Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. (3) Neither the name of the Leland Stanford Junior University, SLAC National Accelerator Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, THE UNITED STATES GOVERNMENT, OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code (\"Enhancements\") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to SLAC National Accelerator Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such Enhancements or derivative works thereof, in binary and source code form. ",
"summary": "Python controls suite for HXRSnD",
"version": "0.3.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ead28bed914108519950d31c6aa29df2310b1d2bcc8d13ffdc82e46d18cce034",
"md5": "dd631c666a4f50a10707dcdbc1e24bd6",
"sha256": "e764c3a13bc88a8975d618d66d25522c7a5c443b4b99f555de1c8bd2ed6b9464"
},
"downloads": -1,
"filename": "hxrsnd-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd631c666a4f50a10707dcdbc1e24bd6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 76366,
"upload_time": "2023-07-26T21:28:35",
"upload_time_iso_8601": "2023-07-26T21:28:35.843400Z",
"url": "https://files.pythonhosted.org/packages/ea/d2/8bed914108519950d31c6aa29df2310b1d2bcc8d13ffdc82e46d18cce034/hxrsnd-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "856b9bd56a204f808eaa377d4f5ac84ed56aee0c75a414f22b146d73729970da",
"md5": "32a5256d7878aaac0470cb6fe2f061ab",
"sha256": "e621666afb2a0400cd6c67dfe491de7efb16ec98fe2a00dc8471156368b97e4f"
},
"downloads": -1,
"filename": "hxrsnd-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "32a5256d7878aaac0470cb6fe2f061ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 114785,
"upload_time": "2023-07-26T21:28:37",
"upload_time_iso_8601": "2023-07-26T21:28:37.217332Z",
"url": "https://files.pythonhosted.org/packages/85/6b/9bd56a204f808eaa377d4f5ac84ed56aee0c75a414f22b146d73729970da/hxrsnd-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-26 21:28:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "hxrsnd"
}
