sagea 0.1.0__tar.gz

sagea-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 NCSG -- Numerical Computation and Satellite Geodesy research group
+
+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.

sagea-0.1.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.1
+Name: sagea
+Version: 0.1.0
+Summary: satellite gravity post-processing and error assessment
+Home-page: https://github.com/NCSGgroup/SaGEA
+Author: Shuhao Liu
+Author-email: liushuhao@hust.edu.cn
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+
+
+# 1. Introduction
+The level-2 time-variable gravity fields obtained from Gravity Recovery and Climate Experiment (GRACE) and its Follow-On (GRACE-FO) mission are widely used in multi-discipline geo-science studies. However, the post-processing of those gravity fields to obtain a desired signal is rather challenging for users that are not familiar with the level-2 products. In addition, the error assessment/quantification of those derived signals, which is of increasing demand in science application, is still a challenging issue even among the professional GRACE(-FO) users. In this effort, the common post-processing steps and the assessment of complicated error (uncertainty) of GRACE(-FO), are integrated into an open-source, cross-platform and Python-based toolbox called SAGEA (SAtellite Gravity Error Assessment). With diverse options, SAGEA provides flexibility to generate signal along with the full error from level-2 products, so that any non-expert user can easily obtain advanced experience of GRACE(-FO) processing. Please contact Shuhao Liu (liushuhao@hust.edu.cn) and Fan Yang (fany@plan.aau.dk) for more information.
+
+When referencing this work, please cite:
+> Liu, S., Yang, F., & Forootan, E. (2025). SAGEA: A toolbox for comprehensive error assessment of GRACE and GRACE-FO based mass changes. Computers & Geosciences, 196, 105825. https://doi.org/10.1016/j.cageo.2024.105825
+

sagea-0.1.0/README.md

@@ -0,0 +1,6 @@
+# 1. Introduction
+The level-2 time-variable gravity fields obtained from Gravity Recovery and Climate Experiment (GRACE) and its Follow-On (GRACE-FO) mission are widely used in multi-discipline geo-science studies. However, the post-processing of those gravity fields to obtain a desired signal is rather challenging for users that are not familiar with the level-2 products. In addition, the error assessment/quantification of those derived signals, which is of increasing demand in science application, is still a challenging issue even among the professional GRACE(-FO) users. In this effort, the common post-processing steps and the assessment of complicated error (uncertainty) of GRACE(-FO), are integrated into an open-source, cross-platform and Python-based toolbox called SAGEA (SAtellite Gravity Error Assessment). With diverse options, SAGEA provides flexibility to generate signal along with the full error from level-2 products, so that any non-expert user can easily obtain advanced experience of GRACE(-FO) processing. Please contact Shuhao Liu (liushuhao@hust.edu.cn) and Fan Yang (fany@plan.aau.dk) for more information.
+
+When referencing this work, please cite:
+> Liu, S., Yang, F., & Forootan, E. (2025). SAGEA: A toolbox for comprehensive error assessment of GRACE and GRACE-FO based mass changes. Computers & Geosciences, 196, 105825. https://doi.org/10.1016/j.cageo.2024.105825
+

sagea-0.1.0/sagea/SHC.py

@@ -0,0 +1,78 @@
+#!/use/bin/env python
+# coding=utf-8
+# @Author  : Shuhao Liu
+# @Time    : 2025/6/13 10:34 
+# @File    : SHC.py
+
+import numpy as np
+
+from sagea.auxiliary.MathTool import MathTool
+
+
+class SHC:
+    """
+    This class is to store the spherical harmonic coefficients (SHCs) for the use in necessary data processing.
+
+    Attribute self.value stores the coefficients in 2d-array (in numpy.ndarray) combined with c and s.
+    which are sorted by degree, for example,
+    numpy.ndarray: [[c1[0,0]; s1[1,1], c1[1,0], c1[1,1]; s1[2,2], s1[2,1], c1[2,0], c1[2,1], c1[2,2]; ...],
+     [c2[0,0]; s2[1,1], c2[1,0], c2[1,1]; s2[2,2], s2[2,1], c2[2,0], c2[2,1], c2[2,2]; ...],
+     [                                        ...                                         ]].
+    Note that even it stores only one set of SHCs, the array is still 2-dimension, i.e.,
+    [[c1[0,0]; s1[1,1], c1[1,0], c1[1,1]; s1[2,2], s1[2,1], c1[2,0], c1[2,1], c1[2,2]; ...]].
+
+    Attribute self.dates stores beginning and ending dates (in datetime.date) in list as
+        list: [
+            [begin_1: datetime,date, begin_2: datetime,date, ...],
+            [end_1: datetime,date, end_2: datetime,date, ...],
+        ] if needed, else None.
+
+    Attribute self.normalization indicates the normalization of the SHCs (in EnumClasses.SHNormalization), for example,
+    EnumClasses.SHNormalization.full.
+
+    Attribute self.physical_dimension indicates the physical dimension of the SHCs (in EnumClasses.PhysicalDimensions).
+    """
+
+    def __init__(self, c, s, normalization=None, physical_dimension=None, perference=None):
+        """
+
+        :param c: harmonic coefficients c in 2-dimension (l,m), or a series (q,l,m);
+        :param s: harmonic coefficients s in 2-dimension (l,m), or a series (q,l,m),
+        :param normalization: in Preference.SHNormalization, default Preference.SHNormalization.full.
+        :param physical_dimension: in Preference.PhysicalDimensions, default Preference.PhysicalDimensions.Dimensionless.
+        """
+
+        assert np.shape(c) == np.shape(s)
+
+        if len(np.shape(c)) == 2:
+            self.value = MathTool.cs_combine_to_triangle_1d(c, s)
+
+        elif len(np.shape(c)) == 3:
+            cs = []
+            for i in range(np.shape(c)[0]):
+                this_cs = MathTool.cs_combine_to_triangle_1d(c[i], s[i])
+                cs.append(this_cs)
+            self.value = np.array(cs)
+
+        if len(np.shape(self.value)) == 1:
+            self.value = self.value[None, :]
+
+        assert len(np.shape(self.value)) == 2
+
+        self.dates = None
+
+        if normalization is None:
+            normalization = perference.SHNormalization.full
+
+        assert normalization in perference.SHNormalization
+        self.normalization = normalization
+
+        if physical_dimension is None:
+            physical_dimension = perference.PhysicalDimensions.Dimensionless
+
+        assert physical_dimension in perference.PhysicalDimensions
+        self.physical_dimension = physical_dimension
+
+
+if __name__ == "__main__":
+    pass

sagea-0.1.0/sagea/__init__.py

@@ -0,0 +1,8 @@
+#!/use/bin/env python
+# coding=utf-8
+# @Author  : Shuhao Liu
+# @Time    : 2025/6/13 10:28 
+# @File    : __init__.py.py
+
+if __name__ == "__main__":
+    pass

sagea-0.1.0/sagea.egg-info/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.1
+Name: sagea
+Version: 0.1.0
+Summary: satellite gravity post-processing and error assessment
+Home-page: https://github.com/NCSGgroup/SaGEA
+Author: Shuhao Liu
+Author-email: liushuhao@hust.edu.cn
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+
+
+# 1. Introduction
+The level-2 time-variable gravity fields obtained from Gravity Recovery and Climate Experiment (GRACE) and its Follow-On (GRACE-FO) mission are widely used in multi-discipline geo-science studies. However, the post-processing of those gravity fields to obtain a desired signal is rather challenging for users that are not familiar with the level-2 products. In addition, the error assessment/quantification of those derived signals, which is of increasing demand in science application, is still a challenging issue even among the professional GRACE(-FO) users. In this effort, the common post-processing steps and the assessment of complicated error (uncertainty) of GRACE(-FO), are integrated into an open-source, cross-platform and Python-based toolbox called SAGEA (SAtellite Gravity Error Assessment). With diverse options, SAGEA provides flexibility to generate signal along with the full error from level-2 products, so that any non-expert user can easily obtain advanced experience of GRACE(-FO) processing. Please contact Shuhao Liu (liushuhao@hust.edu.cn) and Fan Yang (fany@plan.aau.dk) for more information.
+
+When referencing this work, please cite:
+> Liu, S., Yang, F., & Forootan, E. (2025). SAGEA: A toolbox for comprehensive error assessment of GRACE and GRACE-FO based mass changes. Computers & Geosciences, 196, 105825. https://doi.org/10.1016/j.cageo.2024.105825
+

sagea-0.1.0/sagea.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+setup.py
+sagea/SHC.py
+sagea/__init__.py
+sagea.egg-info/PKG-INFO
+sagea.egg-info/SOURCES.txt
+sagea.egg-info/dependency_links.txt
+sagea.egg-info/requires.txt
+sagea.egg-info/top_level.txt

sagea-0.1.0/sagea.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sagea-0.1.0/sagea.egg-info/requires.txt

@@ -0,0 +1 @@
+numpy

sagea-0.1.0/sagea.egg-info/top_level.txt

@@ -0,0 +1 @@
+sagea

sagea-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sagea-0.1.0/setup.py

@@ -0,0 +1,131 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Note: To use the 'upload' functionality of this file, you must:
+#   $ pipenv install twine --dev
+
+import io
+import os
+import sys
+from shutil import rmtree
+
+from setuptools import find_packages, setup, Command
+
+# Package meta-data.
+NAME = 'sagea'
+DESCRIPTION = 'satellite gravity post-processing and error assessment'
+URL = 'https://github.com/NCSGgroup/SaGEA'
+EMAIL = 'liushuhao@hust.edu.cn'
+AUTHOR = 'Shuhao Liu'
+REQUIRES_PYTHON = '>=3.9.0'
+VERSION = '0.1.0'
+
+# What packages are required for this module to be executed?
+REQUIRED = [
+    'numpy',
+]
+
+# What packages are optional?
+EXTRAS = {
+    # 'fancy feature': ['django'],
+}
+
+# The rest you shouldn't have to touch too much :)
+# ------------------------------------------------
+# Except, perhaps the License and Trove Classifiers!
+# If you do change the License, remember to change the Trove Classifier for that!
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+# Import the README and use it as the long-description.
+# Note: this will only work if 'README.md' is present in your MANIFEST.in file!
+try:
+    with io.open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
+        long_description = '\n' + f.read()
+except FileNotFoundError:
+    long_description = DESCRIPTION
+
+# Load the package's __version__.py module as a dictionary.
+about = {}
+if not VERSION:
+    project_slug = NAME.lower().replace("-", "_").replace(" ", "_")
+    with open(os.path.join(here, project_slug, '__version__.py')) as f:
+        exec(f.read(), about)
+else:
+    about['__version__'] = VERSION
+
+
+class UploadCommand(Command):
+    """Support setup.py upload."""
+
+    description = 'Build and publish the package.'
+    user_options = []
+
+    @staticmethod
+    def status(s):
+        """Prints things in bold."""
+        print('\033[1m{0}\033[0m'.format(s))
+
+    def initialize_options(self):
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        try:
+            self.status('Removing previous builds…')
+            rmtree(os.path.join(here, 'dist'))
+        except OSError:
+            pass
+
+        self.status('Building Source and Wheel (universal) distribution…')
+        os.system('{0} setup.py sdist bdist_wheel --universal'.format(sys.executable))
+
+        self.status('Uploading the package to PyPI via Twine…')
+        os.system('twine upload dist/*')
+
+        self.status('Pushing git tags…')
+        os.system('git tag v{0}'.format(about['__version__']))
+        os.system('git push --tags')
+
+        sys.exit()
+
+
+# Where the magic happens:
+setup(
+    name=NAME,
+    version=about['__version__'],
+    description=DESCRIPTION,
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    author=AUTHOR,
+    author_email=EMAIL,
+    python_requires=REQUIRES_PYTHON,
+    url=URL,
+    packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
+    # If your package is a single module, use this instead of 'packages':
+    # py_modules=['mypackage'],
+
+    # entry_points={
+    #     'console_scripts': ['mycli=mymodule:cli'],
+    # },
+    install_requires=REQUIRED,
+    extras_require=EXTRAS,
+    include_package_data=True,
+    license='MIT',
+    classifiers=[
+        # Trove classifiers
+        # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Programming Language :: Python :: Implementation :: PyPy'
+    ],
+    # $ setup.py publish support.
+    cmdclass={
+        'upload': UploadCommand,
+    },
+)