Skip to content

Latest commit

 

History

History
272 lines (186 loc) · 10.2 KB

CONTRIBUTING.rst

File metadata and controls

272 lines (186 loc) · 10.2 KB
Raw

Contributing

Welcome to ecmwf_models contributor's guide.

This document focuses on getting any potential contributor familiarized with the development processes, but other kinds of contributions are also appreciated.

If you are new to using git or have never collaborated in a project previously, please have a look at contribution-guide.org. Other resources are also listed in the excellent guide created by FreeCodeCamp [1].

Please notice, all users and contributors are expected to be open, considerate, reasonable, and respectful. When in doubt, Python Software Foundation's Code of Conduct is a good reference in terms of behavior guidelines.

Issue Reports

If you experience bugs or general issues with ecmwf_models, please have a look on the issue tracker. If you don't see anything useful there, please feel free to fire an issue report.

Tip

Please don't forget to include the closed issues in your search. Sometimes a solution was already reported, and the problem is considered solved.

New issue reports should include information about your programming environment (e.g., operating system, Python version) and steps to reproduce the problem. Please try also to simplify the reproduction steps to a very minimal example that still illustrates the problem you are facing. By removing other factors, you help us to identify the root cause of the issue.

Documentation Improvements

You can help improve ecmwf_models docs by making them more readable and coherent, or by adding missing information and correcting mistakes.

ecmwf_models documentation uses Sphinx as its main documentation compiler. This means that the docs are kept in the same repository as the project code, and that any documentation update is done in the same way was a code contribution.

We provide docs in reStructuredText format.

When working on documentation changes in your local machine, you can compile them using:

python setup.py build_sphinx

and use Python's built-in web server for a preview in your web browser (http://localhost:8000):

python3 -m http.server --directory 'docs/_build/html'

Code Contributions

The package consists of three modules for each supported dataset.

1) A download module that implements the command line interface to retrieve data from ECMWF. 2) A image stack reader to extract information for specific locations for specific variables from grib and netcdf files. 3) A reshuffle module to transpose the image stacks into a time series format for subsequent, performant reading.

Submit an issue

Before you work on any non-trivial code contribution it's best to first create a report in the issue tracker to start a discussion on the subject. This often provides additional considerations and avoids unnecessary work.

Create an environment

Before you start coding, we recommend creating an isolated virtual environment to avoid any problems with your installed Python packages. This can easily be done via Miniconda:

conda create -n ecmwf_models python=3.12 pygrib netcdf4 pyresample pykdtree
conda activate ecmwf_models

Clone the repository

  1. Create an user account on GitHub if you do not already have one.

  2. Fork the project repository: click on the Fork button near the top of the page. This creates a copy of the code under your account on GitHub.

  3. Clone this copy to your local disk (note use the --recurive flag to dowload test data as well:

    git clone --recusive git@github.com:YourLogin/ecmwf_models.git
cd ecmwf_models

  4. You should run:

    pip install -U pip setuptools -e .

    to be able run putup --help.

  5. Install pre-commit:

    pip install pre-commit
pre-commit install

    ecmwf_models comes with a lot of hooks configured to automatically help the developer to check the code being written.

Implement your changes

  1. Create a branch to hold your changes:

    git checkout -b my-feature

    and start making changes. Never work on the master branch!

  2. Start your work on this branch. Don't forget to add docstrings to new functions, modules and classes, especially if they are part of public APIs.

  3. Add yourself to the list of contributors in AUTHORS.rst.

  4. When you’re done editing, do:

    git add <MODIFIED FILES>
git commit

    to record your changes in git.

    Please make sure to see the validation messages from pre-commit and fix any eventual issues with the code styling. Note that you can use in line commands like # noqa: E722 to exclude lines under certain conditions.

    Important

    Don't forget to add unit tests and documentation in case your contribution adds an additional feature and is not just a bugfix.

    Moreover, writing a descriptive commit message is highly recommended. In case of doubt, you can check the commit history with:

    git log --graph --decorate --pretty=oneline --abbrev-commit --all

    to look for recurring communication patterns.

  5. Please check that your changes don't break any unit tests with:

    pytest

Note: A common mistake that leads to failing tests is missing test data.
Make sure that you have downloaded available test data into `tests/ecmwf_models-test-data`.

In case you forgot the `--recusive` flag when cloning the repo, you can run the
following commands to get the test data::

    git submodule init
    git submodule update

Code styling

To apply pep8 conform styling to any changed files we use yapf. The correct settings are already set in setup.cfg. Therefore the following command should be enough:

yapf file.py --in-place

Afterwards the file should be styled correctly, i.e. the pre-commit hooks should pass. If there are still issues, they must be fixed manually.

Submit your contribution

  1. If everything works fine, push your local branch to GitHub with:

    git push -u origin my-feature

  2. Go to the web page of your fork and click "Create pull request" to send your changes for review.

Troubleshooting

The following tips can be used when facing problems to build or test the package:

  1. Make sure to fetch all the tags from the upstream repository. The command git describe --abbrev=0 --tags should return the version you are expecting. If you are trying to run CI scripts in a fork repository, make sure to push all the tags. You can also try to remove all the egg files or the complete egg folder, i.e., .eggs, as well as the *.egg-info folders in the src folder or potentially in the root of your project.

Maintainer tasks

Releases

If you are part of the group of maintainers you can release a new version of this package. Make sure all tests are passing on the master branch and the CHANGELOG.rst file is up-to-date, with changes for the new version at the top.

Then draft a new release on GitHub. Create a version tag following the v{MAJOR}.{MINOR}.{PATCH} pattern. This will trigger a new build on GitHub and should push the packages to pypi after all tests have passed.

If this does not work (tests pass but upload fails) you can download the whl and dist packages for each workflow run from https://github.com/TUW-GEO/ecmwf_models/actions (Artifacts) and push them manually to https://pypi.org/project/ecmwf_models/ e.g. using twine (you need to be a package maintainer on pypi for that).

[1]Even though, these resources focus on open source projects and communities, the general ideas behind collaborating with other developers to collectively create software are general and can be applied to all sorts of environments, including private companies and proprietary code bases.