| Name | qa4sm-reader JSON |
| Version |
0.12.1
JSON |
| download |
| home_page | None |
| Summary | Processes output of qa4sm.eodc.eu (NetCDF file), creating plots and providing the data in other formats. |
| upload_time | 2025-11-07 14:18:20 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | mit |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
============
qa4sm_reader
============
|ci| |cov| |pip|
.. |ci| image:: https://github.com/awst-austria/qa4sm-reader/actions/workflows/build.yml/badge.svg?branch=master
:target: https://github.com/awst-austria/qa4sm-reader/actions
.. |cov| image:: https://coveralls.io/repos/awst-austria/qa4sm-reader/badge.png?branch=master
:target: https://coveralls.io/r/awst-austria/qa4sm-reader?branch=master
.. |pip| image:: https://badge.fury.io/py/qa4sm-reader.svg
:target: https://badge.fury.io/py/qa4sm-reader
qa4sm_reader is a python package to read and plot the result files of the `qa4sm service`_.
Installation
============
This package should be installable through pip
.. code::
pip install qa4sm_reader
Usage
=====
This package is used to analyze a qa4sm netCDF output file and produce all relevant plots and maps.
Development Setup
=================
The project was setup using `pyscaffold`_ and closely follows the recommendations.
Install Dependencies
--------------------
For Development we recommend creating a ``conda`` environment.
.. code::
cd qa4sm-reader
conda env create python=3.10 # create environment from requirements.rst
conda activate qa4sm_reader
conda env update -f environment.yml -n qa4sm_reader
pip install -e .
To remove the environment again, run:
.. code::
conda deactivate
conda env remove -n qa4sm_reader
Code Formatting
---------------
To apply pep8 conform styling to any changed files [we use `yapf`](https://github.com/google/yapf). The correct
settings are already set in `setup.cfg`. Therefore the following command
should be enough:
.. code::
yapf file.py --in-place
Testing
-------
For testing, we use ``py.test``:
.. code::
pytest
The dependencies are automatically installed by `pytest-runner`_ when you run the tests. The test-dependencies are listed in the ``testing`` field inside the ``[options.extras_require]`` section of ``setup.cfg``.
For some reasons, the dependencies are not installed as expected. To workaround, do:
.. code::
pip install pytest-cov
The files used for testing are included in this package. They are however subject to other `terms and conditions`_.
Known Issues
------------
No known issues - please `open an issue`_ in case you come across a malfunctioning in the package.
.. _qa4sm service: https://qa4sm.eu
.. _pyscaffold: https://pyscaffold.org
.. _pytest-runner: https://github.com/pytest-dev/pytest-runner
.. _terms and conditions: https://qa4sm.eu/terms
.. _open an issue: https://github.com/awst-austria/qa4sm-reader/issues
Raw data
{
"_id": null,
"home_page": null,
"name": "qa4sm-reader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "TU Wien <support@qa4sm.eu>",
"download_url": "https://files.pythonhosted.org/packages/b3/1b/58f61d18d5ccd18412b2ac8ee4939858dff6f54d820b631c311a2cf38d63/qa4sm_reader-0.12.1.tar.gz",
"platform": null,
"description": "============\nqa4sm_reader\n============\n\n|ci| |cov| |pip|\n\n.. |ci| image:: https://github.com/awst-austria/qa4sm-reader/actions/workflows/build.yml/badge.svg?branch=master\n :target: https://github.com/awst-austria/qa4sm-reader/actions\n\n.. |cov| image:: https://coveralls.io/repos/awst-austria/qa4sm-reader/badge.png?branch=master\n :target: https://coveralls.io/r/awst-austria/qa4sm-reader?branch=master\n\n.. |pip| image:: https://badge.fury.io/py/qa4sm-reader.svg\n :target: https://badge.fury.io/py/qa4sm-reader\n\n\nqa4sm_reader is a python package to read and plot the result files of the `qa4sm service`_.\n\n\nInstallation\n============\n\nThis package should be installable through pip\n\n.. code::\n\n pip install qa4sm_reader\n\nUsage\n=====\n\nThis package is used to analyze a qa4sm netCDF output file and produce all relevant plots and maps.\n\nDevelopment Setup\n=================\n\nThe project was setup using `pyscaffold`_ and closely follows the recommendations.\n\nInstall Dependencies\n--------------------\n\nFor Development we recommend creating a ``conda`` environment.\n\n.. code::\n\n cd qa4sm-reader\n conda env create python=3.10 # create environment from requirements.rst\n conda activate qa4sm_reader\n conda env update -f environment.yml -n qa4sm_reader\n pip install -e .\n\nTo remove the environment again, run:\n\n.. code::\n\n conda deactivate\n conda env remove -n qa4sm_reader\n\nCode Formatting\n---------------\nTo apply pep8 conform styling to any changed files [we use `yapf`](https://github.com/google/yapf). The correct\nsettings are already set in `setup.cfg`. Therefore the following command\nshould be enough:\n\n.. code::\n\n yapf file.py --in-place\n\nTesting\n-------\n\nFor testing, we use ``py.test``:\n\n.. code::\n\n pytest\n\n\nThe dependencies are automatically installed by `pytest-runner`_ when you run the tests. The test-dependencies are listed in the ``testing`` field inside the ``[options.extras_require]`` section of ``setup.cfg``.\nFor some reasons, the dependencies are not installed as expected. To workaround, do:\n\n.. code::\n\n pip install pytest-cov\n\nThe files used for testing are included in this package. They are however subject to other `terms and conditions`_.\n\nKnown Issues\n------------\n\nNo known issues - please `open an issue`_ in case you come across a malfunctioning in the package.\n\n\n.. _qa4sm service: https://qa4sm.eu\n.. _pyscaffold: https://pyscaffold.org\n.. _pytest-runner: https://github.com/pytest-dev/pytest-runner\n.. _terms and conditions: https://qa4sm.eu/terms\n.. _open an issue: https://github.com/awst-austria/qa4sm-reader/issues\n",
"bugtrack_url": null,
"license": "mit",
"summary": "Processes output of qa4sm.eodc.eu (NetCDF file), creating plots and providing the data in other formats.",
"version": "0.12.1",
"project_urls": {
"Documentation": "https://qa4sm-reader.readthedocs.io/en/latest/",
"Homepage": "https://github.com/awst-austria/qa4sm-reader"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "917567c062a892060953cd92213124742d4ea4477f041c6ee5d7758c1b962ab5",
"md5": "afa922edfcbc858eb4c607b6ca1679f1",
"sha256": "44b800273925b984b1288337b0835672c05a9ba6cdd884330d299a0f4f2ff52e"
},
"downloads": -1,
"filename": "qa4sm_reader-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afa922edfcbc858eb4c607b6ca1679f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 154418,
"upload_time": "2025-11-07T14:18:18",
"upload_time_iso_8601": "2025-11-07T14:18:18.343792Z",
"url": "https://files.pythonhosted.org/packages/91/75/67c062a892060953cd92213124742d4ea4477f041c6ee5d7758c1b962ab5/qa4sm_reader-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b31b58f61d18d5ccd18412b2ac8ee4939858dff6f54d820b631c311a2cf38d63",
"md5": "6e9e7fdd6f8dc1cb6fbe4a076c396764",
"sha256": "9640b109b52856563fe3696c83528e673ed6743441afa187cc23624cdc6d8fe7"
},
"downloads": -1,
"filename": "qa4sm_reader-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "6e9e7fdd6f8dc1cb6fbe4a076c396764",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 29518288,
"upload_time": "2025-11-07T14:18:20",
"upload_time_iso_8601": "2025-11-07T14:18:20.387801Z",
"url": "https://files.pythonhosted.org/packages/b3/1b/58f61d18d5ccd18412b2ac8ee4939858dff6f54d820b631c311a2cf38d63/qa4sm_reader-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-07 14:18:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awst-austria",
"github_project": "qa4sm-reader",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "qa4sm-reader"
}
