Metadata-Version: 2.4
Name: pysmurf-slac
Version: 11.1.1
Summary: The python control software for SMuRF
Project-URL: Bug Tracker, https://github.com/slaclab/pysmurf/issues
Project-URL: Documentation, https://pysmurf.readthedocs.io
Project-URL: Homepage, https://github.com/slaclab/pysmurf
Project-URL: Source Code, https://github.com/slaclab/pysmurf
License: Copyright (c) 2024, 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.
        
License-File: LICENSE.txt
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: cython
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: packaging
Requires-Dist: pyepics
Requires-Dist: pyyaml
Requires-Dist: schema
Requires-Dist: scipy
Requires-Dist: seaborn
Description-Content-Type: text/markdown

# pysmurf

[DOE Code](https://www.osti.gov/doecode/biblio/75053)

[![pypi](https://img.shields.io/pypi/v/pysmurf-slac)](https://pypi.org/project/pysmurf-slac/) ![versions](https://img.shields.io/pypi/pyversions/pysmurf-slac) [![test-or-deploy](https://img.shields.io/github/actions/workflow/status/slaclab/pysmurf/test-or-deploy.yml)](https://github.com/slaclab/pysmurf/actions/workflows/test-or-deploy.yml) [![Documentation Status](https://readthedocs.org/projects/pysmurf/badge/?version=main)](https://pysmurf.readthedocs.io/en/main/?badge=main)

The python control software for SMuRF. Includes scripts to do low level
commands as well as higher level analysis.

## Installation
Install pysmurf using pip:
```
pip3 install pysmurf-slac
```

### Installing from Source
To install from source clone this repository and install using pip:

```
git clone https://github.com/slaclab/pysmurf.git
cd pysmurf/
pip3 install .
```

## Documentation
Documentation is built using Sphinx, and follows the [NumPy Style
Docstrings][1] convention. To build the documentation first install
the pysmurf package, then run:

```
cd docs/
make html
```

Output will be located in `_build/html`. You can view the compiled
documentation by opening `_build/html/index.html` in the browser of your choice.

The documentation is also updated to readthedocs here: https://pysmurf.readthedocs.io/en/main/

[1]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
