Commit 803e2793 authored by payno's avatar payno
Browse files

Merge branch 'move_to_summary' into 'master'

[doc] move to autosumary and improve doc

See merge request workflow/est!48
parents 335339a0 4e601b4f
Pipeline #55881 failed with stages
in 4 minutes and 40 seconds
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""contains `energy roi` related functions / classes"""
__authors__ = ["H. Payno"] __authors__ = ["H. Payno"]
__license__ = "MIT" __license__ = "MIT"
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to the larch mback process""" """wrapper to the larch mback-norm process"""
from est.core.types import Spectrum, XASObject from est.core.types import Spectrum, XASObject
from est.core.process.process import Process from est.core.process.process import Process
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to the larch mback process""" """wrapper to the larch pre-edge process"""
from est.core.types import Spectrum, XASObject from est.core.types import Spectrum, XASObject
from est.core.process.process import Process from est.core.process.process import Process
......
# coding: utf-8
# /*##########################################################################
# Copyright (C) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ############################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "07/25/2019"
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to the larch mback process""" """wrapper to the larch xftf process"""
from est.core.types import Spectrum, XASObject from est.core.types import Spectrum, XASObject
from est.core.process.process import Process from est.core.process.process import Process
......
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to pymca `exafs` process"""
__authors__ = ["H. Payno"] __authors__ = ["H. Payno"]
__license__ = "MIT" __license__ = "MIT"
......
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to pymca `ft` process"""
__authors__ = ["H. Payno"] __authors__ = ["H. Payno"]
__license__ = "MIT" __license__ = "MIT"
......
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to pymca `k-weight` process"""
__authors__ = ["H. Payno"] __authors__ = ["H. Payno"]
__license__ = "MIT" __license__ = "MIT"
......
...@@ -22,6 +22,7 @@ ...@@ -22,6 +22,7 @@
# THE SOFTWARE. # THE SOFTWARE.
# #
# ###########################################################################*/ # ###########################################################################*/
"""wrapper to pymca `normalization` process"""
__authors__ = ["H. Payno"] __authors__ = ["H. Payno"]
__license__ = "MIT" __license__ = "MIT"
......
# coding: utf-8
# /*##########################################################################
# Copyright (C) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ############################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "07/21/2021"
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2016-2018 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "06/12/2019"
import logging
_logger = logging.getLogger(__name__)
"""
est.core.types module: contains main core level est types
"""
from .spectrum import Spectrum # noqa from .spectrum import Spectrum # noqa
from .spectra import Spectra # noqa from .spectra import Spectra # noqa
from .sample import Sample # noqa from .sample import Sample # noqa
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment