/S4Utils

Utility functions for S4 and the python API

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Welcome to S4Utils documentation

authors: Mathieu Jeannin Paul Goulain

affiliations: Centre de Nanosciences et de Nanotechnologies (2020)

Installation

You should be able to install using pip install . or running python setup.py install, from the project root directory. Otherwise just copy the S4Utils folder somewhere where python will find it or add the path to your PYTHONPATH variable.

Prerequisite: NumPy, SciPy, Matplotlib, Pyvista

Documentation

See the manual on for the documentation.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Copyright (C) Mathieu Jeannin, Paul Goulain, 2020 .