Generalization results

.github/workflows/build.yml

@@ -1,37 +1,28 @@
-name: Build
+name: Build and test Python package
 
 on: [push, pull_request]
 
 jobs:
 
   build:
-    name: Build for ${{ matrix.python-version }}
-    runs-on: 'ubuntu-latest'
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.9', '3.10']
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+        python-version: ['3.10', '3.11']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Python info
-        shell: bash -l {0}
-        run: |
-          which python
-          python --version
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
-      - name: Build
-        shell: bash -l {0}
-        run: |
-          python setup.py build
-      - name: Test
-        shell: bash -l {0}
-        run: |
-          pip install pytest pytest-cov pycodestyle
-          pytest --cov --cov-report term --cov-report xml --junitxml=xunit-result.xml
+          python -m pip install build
+          python -m pip install .[dev]
+      - name: Build the package
+        run: python -m build
+      - name: Run tests
+        run: pytest tests/

.github/workflows/lint.yml

@@ -0,0 +1,8 @@
+name: Ruff lint
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1

README.md

@@ -0,0 +1,22 @@
+# MOTrainer: Measurement Operator Trainer
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7540443.svg)](https://doi.org/10.5281/zenodo.7540443)
+
+Measurement Operator Trainer is a Python package training measurement operators 
+(MO) for data assimilations purposes. It is specifically designed for the aplications where one needs to split large spatio-temporal data into independent partitions, and then train separate ML models for each partition.
+
+Please refer to the MOtrainer documentation for more details.
+
+Copyright (c) 2021, 
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).

docs/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+
+[0.1.0] - 2023-12-21
+********************
+
+Added
+-----
+
+The first version of the MOTrainer package. The following functionalities are implemented:
+- Spatio temporal Dataset split;
+- Jackknife GPI implementation;
+- Documentation and examples for distributed training;
+- Relevant tests.

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+This code of conduct is adapted from the 
+[Git Code of Conduct](https://github.com/git/git/blob/master/CODE_OF_CONDUCT.md).
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when
+an individual is representing the project or its community. Examples of representing
+a project or community include using an official project e-mail address, posting via
+an official social media account, or acting as an appointed representative at an
+online or offline event. Representation of a project may be further defined and
+clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected].
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All Project maintainers are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4, 
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

docs/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+
+# MOTrainer Contributing Guidelines
+
+
+We welcome any kind of contribution to our software, from simple comment 
+or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). 
+Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+A contribution can be one of the following cases:
+
+- you have a question;
+- you think you may have found a bug (including unexpected behavior);
+- you want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation).
+
+The sections below outline the steps in each case.
+
+## You have a question
+
+-  use the search functionality [here](https://github.com/VegeWaterDynamics/motrainer/issues)
+to see if someone already filed the same issue;
+-  if your issue search did not yield any relevant results, make a new issue;
+-  apply the "question" label; apply other labels when relevant.
+
+## You think you may have found a bug
+
+- use the search functionality [here](https://github.com/VegeWaterDynamics/motrainer/issues) to see if someone already filed the same issue;
+- if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
+    - the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas>) of the commit that is causing your problem;
+    - some identifying information (name and version number) for dependencies you're using;
+    - information about the operating system;
+- apply relevant labels to the newly created issue.
+
+## You want to make some kind of change to the code base
+
+- (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
+- (**important**) wait until some kind of consensus is reached about your idea being a good idea;
+- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
+- make sure the existing tests still work. First, install the development dependencies as `pip install .[dev]`, and then run `pytest tests`;
+- add your own tests (if necessary);
+- update or expand the documentation. Make sure the documentation is built successfully: first, install documentation dependencies as `pip install .[docs]` and then run `mkdocs build`.
+- make sure the linting tests pass by running `ruff` in the project root directory: `ruff check .`;
+- [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the MOTrainer repository on GitHub;
+- create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
+
+In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.