Skip to content

lnls-sol/py4syn

Repository files navigation

Welcome to Py4Syn

Documentation Status Code Health

Purpose

Py4Syn is a combined effort to provide a minimum operational set of Python classes and scripts which support the basic and common operations at the Brazilian Synchrotron Light Laboratory (LNLS).

Citation

To cite Py4Syn in publications use

Slepicka, H. H., Canova, H. F., Beniz, D. B., & Piton, J. R. (2015). Py4Syn: Python for synchrotrons. Journal of Synchrotron Radiation, 22(5), 1182–1189. https://doi.org/10.1107/S1600577515013715

A BibTeX entry for LaTeX users is

@article{Slepicka2015,
 abstract = {{\textless}p{\textgreater} In this report, {\textless}italic{\textgreater}Py4Syn{\textless}/italic{\textgreater} , an open-source Python-based library for data acquisition, device manipulation, scan routines and other helper functions, is presented. Driven by easy-to-use and scalability ideals, {\textless}italic{\textgreater}Py4Syn{\textless}/italic{\textgreater} offers control system agnostic solution and high customization level for scans and data output, covering distinct techniques and facilities. Here, most of the library functionalities are described, examples of use are shown and ideas for future implementations are presented. {\textless}/p{\textgreater}},
 author = {Slepicka, H. H. and Canova, H. F. and Beniz, D. B. and Piton, J. R.},
 doi = {10.1107/S1600577515013715},
 issn = {1600-5775},
 journal = {Journal of Synchrotron Radiation},
 keywords = {data acquisition,py4syn,python},
 number = {5},
 pages = {1182--1189},
 title = {Py4Syn: Python for synchrotrons},
 url = {http://scripts.iucr.org/cgi-bin/paper?S1600577515013715},
 volume = {22},
 year = {2015}
}

Py4Syn is ISC licensed, so you are free to use it whatever you like, be it academic, commercial, creating forks or derivatives (see the LICENSE file for details). That said, although not required by the Py4Syn license, if it is convenient for you, please cite Py4Syn when using it in your work and also consider contributing all your changes back, so that we can incorporate it and all of us will benefit in the end.