| Name | hutch-python JSON |
| Version |
1.21.0
JSON |
| download |
| home_page | None |
| Summary | Launcher and Config Reader for LCLS Interactive IPython Sessions |
| upload_time | 2024-08-26 21:45:28 |
| maintainer | None |
| 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.
|
============
Hutch Python
============
.. image:: https://travis-ci.org/pcdshub/hutch-python.svg?branch=master
:target: https://travis-ci.org/pcdshub/hutch-python
:alt: Build Status
``hutch-python`` is the launcher and config reader for LCLS interactive IPython
sessions. The documentation is hosted at
`<https://pcdshub.github.io/hutch-python>`_.
Requirements
------------
This module is intended to be run using the latest pcds release in the
`pcds-envs <https://github.com/pcdshub/pcds-envs>`_ package.
This module requires Python 3.6+ and the following utilities:
- ``ipython``, for improved interactive sessions
- `pcdsdaq <https://github.com/pcdshub/pcdsdaq>`_
for using the daq in scans
- `pcdsdevices <https://github.com/pcdshub/pcdsdevices>`_
for our Device abstraction layers
- `elog <https://github.com/pcdshub/elog>`_
for posting to the LCLS experiment elogs
- `happi <https://github.com/pcdshub/happi>`_
to enable device loading from a happi database
- `psdm_qs_cli <https://github.com/slaclab/psdm_qs_cli>`_
as an optional happi dependency for loading from the experiment
questionnaire
- `lightpath <https://github.com/pcdshub/lightpath>`_
organizes devices to provide a summarized state of the beamline as a whole
- ``pyyaml``, for reading config files
- ``coloredlogs``, for colored logging
- ``pyfiglet`` for hutch banners (think big ``xpppython`` on startup)
- `cookiecutter <https://github.com/audreyr/cookiecutter>`_
for starting new hutch repos
To connect to the LCLS DAQ, your environment must have access to
- ``pydaq`` for connecting to and running the daq
- ``pycdb`` for changing daq object configurations
- ``pyami`` for viewing data from the daq
These are not available outside of the slac intranet, and in some cases
must be sync'd with the active DAQ versions, independent of all other
packages.
To automatically select the current experiment, you must run with access to
the LCLS NFS directories.
Raw data
{
"_id": null,
"home_page": null,
"name": "hutch-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "SLAC National Accelerator Laboratory",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e5/dc/02eba7fc5746a5003b782edf4f923fb3d8f3e1991005989e5a4ac72739d6/hutch_python-1.21.0.tar.gz",
"platform": null,
"description": "============\nHutch Python\n============\n.. image:: https://travis-ci.org/pcdshub/hutch-python.svg?branch=master\n :target: https://travis-ci.org/pcdshub/hutch-python\n :alt: Build Status\n\n``hutch-python`` is the launcher and config reader for LCLS interactive IPython\nsessions. The documentation is hosted at\n`<https://pcdshub.github.io/hutch-python>`_.\n\nRequirements\n------------\n\nThis module is intended to be run using the latest pcds release in the\n`pcds-envs <https://github.com/pcdshub/pcds-envs>`_ package.\n\nThis module requires Python 3.6+ and the following utilities:\n\n- ``ipython``, for improved interactive sessions\n- `pcdsdaq <https://github.com/pcdshub/pcdsdaq>`_\n for using the daq in scans\n- `pcdsdevices <https://github.com/pcdshub/pcdsdevices>`_\n for our Device abstraction layers\n- `elog <https://github.com/pcdshub/elog>`_\n for posting to the LCLS experiment elogs\n- `happi <https://github.com/pcdshub/happi>`_\n to enable device loading from a happi database\n- `psdm_qs_cli <https://github.com/slaclab/psdm_qs_cli>`_\n as an optional happi dependency for loading from the experiment\n questionnaire\n- `lightpath <https://github.com/pcdshub/lightpath>`_\n organizes devices to provide a summarized state of the beamline as a whole\n- ``pyyaml``, for reading config files\n- ``coloredlogs``, for colored logging\n- ``pyfiglet`` for hutch banners (think big ``xpppython`` on startup)\n- `cookiecutter <https://github.com/audreyr/cookiecutter>`_\n for starting new hutch repos\n\nTo connect to the LCLS DAQ, your environment must have access to\n\n- ``pydaq`` for connecting to and running the daq\n- ``pycdb`` for changing daq object configurations\n- ``pyami`` for viewing data from the daq\n\nThese are not available outside of the slac intranet, and in some cases\nmust be sync'd with the active DAQ versions, independent of all other\npackages.\n\nTo automatically select the current experiment, you must run with access to\nthe LCLS NFS directories.\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": "Launcher and Config Reader for LCLS Interactive IPython Sessions",
"version": "1.21.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc6d030dc5e74214f2202d52119662ad98a106223936d64df145fd9254fbfe2b",
"md5": "c9130c46b764261d55a40f6e2f4f80b4",
"sha256": "f0d7fefc6a217d72db246b1b1cb684349bc07c3dd7e6f15ef93dde4701ba10b7"
},
"downloads": -1,
"filename": "hutch_python-1.21.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9130c46b764261d55a40f6e2f4f80b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 102610,
"upload_time": "2024-08-26T21:45:27",
"upload_time_iso_8601": "2024-08-26T21:45:27.375147Z",
"url": "https://files.pythonhosted.org/packages/bc/6d/030dc5e74214f2202d52119662ad98a106223936d64df145fd9254fbfe2b/hutch_python-1.21.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5dc02eba7fc5746a5003b782edf4f923fb3d8f3e1991005989e5a4ac72739d6",
"md5": "4f71d6a9dae46f9ea5a657d547e1cb3d",
"sha256": "384d954e864721e2eabcaa5c4f9bca9f88548225d4ca08579f57fead241fb96b"
},
"downloads": -1,
"filename": "hutch_python-1.21.0.tar.gz",
"has_sig": false,
"md5_digest": "4f71d6a9dae46f9ea5a657d547e1cb3d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 168999,
"upload_time": "2024-08-26T21:45:28",
"upload_time_iso_8601": "2024-08-26T21:45:28.456070Z",
"url": "https://files.pythonhosted.org/packages/e5/dc/02eba7fc5746a5003b782edf4f923fb3d8f3e1991005989e5a4ac72739d6/hutch_python-1.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 21:45:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "hutch-python"
}
