easyscience 0.0.1a0__tar.gz → 0.6.0__tar.gz

easyscience-0.6.0/.gitignore

@@ -0,0 +1,49 @@
+# QtCreator
+*.autosave
+
+# QtCreator Qml
+*.qmlproject.user
+*.qmlproject.user.*
+
+# QtCreator Python
+*.pyproject.user
+*.pyproject.user.*
+
+# QtCreator CMake
+CMakeLists.txt.user*
+
+# Python
+__pycache__
+.venv
+.coverage
+.pyc
+
+# Poetry
+dist
+poetry.lock
+*.egg-info
+
+# PyInstaller
+build
+*.spec
+
+# Jupyter
+.ipynb_checkpoints
+
+# macOS
+.DS_Store
+*.app
+*.dmg
+
+# Docs
+docs/_build
+
+# VSCode
+.vscode
+
+# Misc
+..*
+*.log
+*.zip
+.ci/
+.idea/

easyscience-0.6.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Easyscience contributors (https://github.com/EasyScience)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

easyscience-0.6.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: EasyScience
+Version: 0.6.0
+Summary: Generic logic for easyScience libraries
+Project-URL: homepage, https://docs.easyscience.org
+Project-URL: documentation, https://docs.easyscience.org
+Author: EasyScience contributors
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, Easyscience contributors (https://github.com/EasyScience)
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: <3.12,>=3.8
+Requires-Dist: asteval
+Requires-Dist: bumps
+Requires-Dist: dfo-ls
+Requires-Dist: lmfit
+Requires-Dist: numpy
+Requires-Dist: pint
+Requires-Dist: uncertainties
+Requires-Dist: xarray
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: codecov; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: matplotlib; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: tox-gh-actions; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: doc8; extra == 'docs'
+Requires-Dist: readme-renderer; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-gallery; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Requires-Dist: toml; extra == 'docs'
+Description-Content-Type: text/markdown
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![PyPI badge](http://img.shields.io/pypi/v/EasyScience.svg)](https://pypi.python.org/pypi/EasyScience)
+[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
+
+# Easyscience
+
+## About
+
+EasyScience package is the foundation of the EasyScience family of projects, providing the building blocks for libraries and applications
+which aim to make scientific data simulation and analysis easier.
+
+## Install
+
+**EasyScience** can be downloaded using pip:
+
+```pip install easyscience```
+
+Or direct from the repository:
+
+```pip install https://github.com/easyScience/EasyScience```
+
+## Test
+
+After installation, launch the test suite:
+
+```python -m pytest```
+
+## Documentation
+
+Documentation can be found at:
+
+[https://easyScience.github.io/EasyScience](https://easyScience.github.io/EasyScience)
+
+## Contributing
+We absolutely welcome contributions. **EasyScience** is maintained by the ESS and on a volunteer basis and thus we need to foster a community that can support user questions and develop new features to make this software a useful tool for all users while encouraging every member of the community to share their ideas.
+
+## License
+While **EasyScience** is under the BSD-3 license, DFO_LS is subject to the GPL license.
+
+

easyscience-0.6.0/README.md

@@ -0,0 +1,40 @@
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![PyPI badge](http://img.shields.io/pypi/v/EasyScience.svg)](https://pypi.python.org/pypi/EasyScience)
+[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
+
+# Easyscience
+
+## About
+
+EasyScience package is the foundation of the EasyScience family of projects, providing the building blocks for libraries and applications
+which aim to make scientific data simulation and analysis easier.
+
+## Install
+
+**EasyScience** can be downloaded using pip:
+
+```pip install easyscience```
+
+Or direct from the repository:
+
+```pip install https://github.com/easyScience/EasyScience```
+
+## Test
+
+After installation, launch the test suite:
+
+```python -m pytest```
+
+## Documentation
+
+Documentation can be found at:
+
+[https://easyScience.github.io/EasyScience](https://easyScience.github.io/EasyScience)
+
+## Contributing
+We absolutely welcome contributions. **EasyScience** is maintained by the ESS and on a volunteer basis and thus we need to foster a community that can support user questions and develop new features to make this software a useful tool for all users while encouraging every member of the community to share their ideas.
+
+## License
+While **EasyScience** is under the BSD-3 license, DFO_LS is subject to the GPL license.
+
+

easyscience-0.6.0/pyproject.toml

@@ -0,0 +1,160 @@
+[build-system]
+requires = [
+    "hatchling<=1.21.0",
+    "setuptools-git-versioning",
+]
+build-backend = "hatchling.build"
+
+[tool.setuptools-git-versioning]
+enabled = true
+
+[project]
+name = "EasyScience"
+dynamic = ["version"]
+description = "Generic logic for easyScience libraries"
+readme = "README.md"
+authors = [{name = "EasyScience contributors"}]
+license = { file = "LICENSE" }
+classifiers = [
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Development Status :: 3 - Alpha"
+]
+requires-python = ">=3.8,<3.12"
+dependencies = [
+    "asteval",
+    "bumps",
+    "DFO-LS",
+    "lmfit",
+    "numpy",
+    "pint",
+    "uncertainties",
+    "xarray"
+]
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "codecov",
+    "flake8",
+    "matplotlib",
+    "pytest",
+    "pytest-cov",
+    "ruff",
+    "tox-gh-actions"
+]
+docs = [
+    "doc8",
+    "readme-renderer",
+    "Sphinx",
+    "sphinx-rtd-theme",
+    "sphinx-autodoc-typehints", 
+    "sphinx-gallery",
+    "toml"
+]
+
+[project.urls]
+homepage = "https://docs.easyscience.org"
+documentation = "https://docs.easyscience.org"
+
+[tool.hatch.version]
+path = "src/easyscience/__version__.py"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.sdist]
+packages = ["src"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/easyscience"]
+
+[tool.coverage.run]
+source = ["src/easyscience"]
+
+[tool.github.info]
+organization = 'easyScience'
+repo = "easyscience"
+
+[tool.ruff]
+line-length = 127
+exclude = [
+    "docs",
+    "examples_old",
+    "tests"
+]
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.per-file-ignores]
+# allow asserts in test files
+"*test_*.py" = ["S101"]
+
+[tool.ruff.lint]
+ignore-init-module-imports = true
+select = [
+    # flake8 settings from existing CI setup
+    "E9", "F63", "F7", "F82",
+    # Code should be polished to fulfill all cases below
+    # https://docs.astral.sh/ruff/rules/
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+#    "UP",
+    # flake8-bugbear
+#    "B",
+    # flake8-simplify
+#    "SIM",
+    # isort
+    "I",
+    # flake8-bandit
+    "S",
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+isolated_build = True
+envlist = py{3.8,3.9,3.10,3.11,3.12}
+[gh-actions]
+python =
+        3.8: py38
+        3.9: py39
+        3.10: py310
+        3.11: py311
+        3.12: py312
+[gh-actions:env]
+PLATFORM =
+    ubuntu-latest: linux
+    macos-latest: macos
+    windows-latest: windows
+[testenv]
+passenv =
+    CI
+    GITHUB_ACTIONS
+    GITHUB_ACTION
+    GITHUB_REF
+    GITHUB_REPOSITORY
+    GITHUB_HEAD_REF
+    GITHUB_RUN_ID
+    GITHUB_SHA
+    COVERAGE_FILE
+deps = coverage
+commands =
+    pip install -e '.[dev]'
+    pytest --cov --cov-report=xml
+"""

easyscience-0.6.0/src/easyscience/Datasets/__init__.py

@@ -0,0 +1,6 @@
+#  SPDX-FileCopyrightText: 2023 EasyScience contributors  <core@easyscience.software>
+#  SPDX-License-Identifier: BSD-3-Clause
+#  © 2021-2023 Contributors to the EasyScience project <https://github.com/easyScience/EasyScience
+
+__author__ = "github.com/wardsimon"
+__version__ = "0.1.0"