Metadata-Version: 2.4
Name: cohere_ui
Version: 4.5.0
Summary: cohere scripts
Author-email: Barbara Frosik <bfrosik@anl.gov>, Ross Harder <rharder@anl.gov>
License: Copyright © 2019, UChicago Argonne, LLC
        All Rights Reserved
         Software Name: CDI Reconstruction (cohere)
        By: Argonne National Laboratory
        OPEN SOURCE LICENSE
        
        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 copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        
        ******************************************************************************************************
        DISCLAIMER
        
        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 HOLDER 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.
        ***************************************************************************************************
        
Project-URL: Homepage, https://github.com/AdvancedPhotonSource/cohere-ui
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyqt5
Requires-Dist: scikit-image
Requires-Dist: xrayutilities
Requires-Dist: pyvista
Requires-Dist: scipy
Requires-Dist: notebook
Requires-Dist: gputil
Requires-Dist: pandas
Requires-Dist: openpyxl
Requires-Dist: xlsxwriter
Dynamic: license-file

# cohere-ui
User files

This repository is submodule of cohere project and contains supplementary scripts to the cohere_core tools https://github.com/advancedPhotonSource/cohere. The cohere-ui package is beamline specific and supports the following beamlines: aps_1ide, aps_34idc, esrf_id01, Petra3_P10.

After installing this repository run installation:

    pip install -e .
    
Content:
1. A directory cohere_ui containing user scripts. Refer to documentation at https://cohere.readthedocs.io/en/latest/how_to_use.html for instruction on how to use the scripts.
2. A directory cohere-defaults containing configuration files listing all parameters. The config_instr and config_prep list parameters used by aps_34idc beamline. The beamline specific configuration is in cohere_ui/beamlines/<beamline> directory, where <beamline> is a specific beamline. Refer to documentation at https://cohere.readthedocs.io/en/latest/configuration.html for detail description of all supported parameters.
3. A directory example_data containing experiment data necessary to conduct analysis.
4. A directory example_workspace directory with example experiment space containing configuration files. The example experiment is provided to users to learn the tools by trying on the real data and real environment.
5. A hpc_scripts directory containing scripts running the tools on Polaris.
