pyXsurf 2.0.0.dev2

Python library for X-Ray Optics, Metrology Data Analysis and Telescopes Design.

Python library for X-Ray Optics, Metrology Data Analysis and Telescopes Design.

This library starts from code collected during many years of work on surface metrology and X-ray optics and wants to offer to the community an extensible tool to perfom common operations on surface and profile data, together with a set of tools to perform typical operations on data, in particular related to X-ray optics.

Installation

Optionally create a virtual environment and activate it.

python3 -m venv pyXsurf.venv
source pyXsurf.venv/bin/activate

And then install the package with pip:

1. Install released version from PyPI:

pip install pyXsurf

or

2. Install latest development version from github:

pip install "pyXsurf @ git+https://github.com/robeyes/pyXsurf.git"

or

3. Clone the repository and install in editable mode for development:

git clone https://github.com/robeyes/pyXsurf.git
cd pyXsurf
pip install -e .

Uninstalling

Project can be uninstalled running pip uninstall pyXsurf or equivalent.

How to use

All modules are packaged into pyXsurf package, you can import them with something like:

import pySurf.data2D

Additional resources for usage guidance

• docs official documentation <https://pyxsurf.readthedocs.io>

• test contains a collection of tests and examples.

• notebooks contains a collection of Jupyter notebooks with examples and tutorials.

Modules

A basic description of the different modules is:

• dataIO Generic routines for accessing and manipulating data and files.

• plotting Plotting functions for pySurf data.

• pyGeo3D Functions for geometry in space (lines and planes).

• pyProfile Equivalent of pySurf acting on Profiles.

• pySurf Functions and classes acting on 3D points or surfaces.

• thermal Functions for modelling of thermal forming of glass.

Contributing

Please report bugs or feature requests, missing documentation, or open a issue on github https://github.com/vincenzooo/pyXsurf/issues.

Acknowledgements

The code in this library is the result of many years of work. Many colleagues from my current or former Institutions contributed directly and indirectly with exchange of code, ideas, data and good time. The ongoing improvements to this project are funded by INAF “Bando per innovazione tecnologica”, which the author also thanks for the supportive and stimulating working environment.

Citation

License

This project is Copyright (c) Vincenzo Cotroneo and licensed under the terms of the BSD 3-Clause license. See the licenses folder for more information.

Author

Vincenzo Cotroneo [e-mail]