Example Satpy Plugin Package - Composites

This is a toy package to show how to make an independent package that adds or changes functionality to Satpy. This package specifically adds new composites, but Satpy also supports adding readers, writers, and enhancements.

See the Satpy Plugin Documentation for more information.

Install

This package is NOT available from PyPI or conda. It is purely an example and proof of concept. It is only possible to install this package from source. If you are hoping to use this package as a starting point then you likely want to install it in "editable" mode. This can be done by running:

pip install -e .

This will make any changes to the Python or YAML content in your package available to your scripts automatically. However, if you change the entry point definitions in the pyproject.toml (or setup.py) you will likely need to reinstall the package by running the above command again.

Repository contents

This project contains five types of files and directories in addition to this README:

1. pyproject.toml: The package and entry point definitions. You could also implement this in a setup.py not shown here.
2. satpy_cpe: The plugin Python package.
3. satpy_cpe/etc: The plugin component configuration directory where custom YAML files are stored.
4. .github: Automated tests run automatically on GitHub. These exist primarily to verify that this example still works with the upstream Satpy package. It is not technically required to make a Satpy plugin package.
5. .gitignore: This file tells git which files not to include when working with git to update this GitHub project repository. This is also not technically needed for the plugin package to work, but is highly recommended in your own projects to avoid committing unwanted files to git.

See the Satpy Plugin Documentation linked above.

Contributing

If you think you've found a bug or have a question about this repository please file a bug on the Satpy repository:

https://github.com/pytroll/satpy/issues

If you would like to contribute changes to this example project, please create a fork of the project, create a new branch, commit your changes to it, and then create a pull request.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

Licenses

Disclaimer: We are not lawyers.

Satpy source code is under the GPLv3 license. This license requires any derivative works to also be GPLv3 or GPLv3 compatible. It is our understanding that importing a Python module could be considered "linking" that source code to your own (thus being a derivative work) and would therefore require your code to be licensed with a GPLv3-compatible license. It is currently only possible to make a Satpy-compatible plugin without importing Satpy if it contains only enhancements. Writers and compositors are possible without subclassing, but are likely difficult to implement. Readers are even more difficult to implement without using Satpy's base classes and utilities. It is also our understanding that if your custom Satpy plugin code is not publicly released then it does not need to be GPLv3.