| Name | qa4sm-reader JSON |
| Version |
0.11
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-02-06 14:04:42 |
| maintainer | None |
| docs_url | None |
| author | TU Wien |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
============
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.10",
"maintainer_email": null,
"keywords": null,
"author": "TU Wien",
"author_email": "support@qa4sm.eu",
"download_url": "https://files.pythonhosted.org/packages/7c/5d/67c511c17c3f31f405b74bd8709a8f7ab29dbace41703e345de75762b99e/qa4sm_reader-0.11.tar.gz",
"platform": null,
"description": "============\r\nqa4sm_reader\r\n============\r\n\r\n|ci| |cov| |pip|\r\n\r\n.. |ci| image:: https://github.com/awst-austria/qa4sm-reader/actions/workflows/build.yml/badge.svg?branch=master\r\n :target: https://github.com/awst-austria/qa4sm-reader/actions\r\n\r\n.. |cov| image:: https://coveralls.io/repos/awst-austria/qa4sm-reader/badge.png?branch=master\r\n :target: https://coveralls.io/r/awst-austria/qa4sm-reader?branch=master\r\n\r\n.. |pip| image:: https://badge.fury.io/py/qa4sm-reader.svg\r\n :target: https://badge.fury.io/py/qa4sm-reader.\r\n\r\n\r\nqa4sm_reader is a python package to read and plot the result files of the `qa4sm service`_.\r\n\r\n\r\nInstallation\r\n============\r\n\r\nThis package should be installable through pip\r\n\r\n.. code::\r\n\r\n pip install qa4sm_reader\r\n\r\nUsage\r\n=====\r\n\r\nThis package is used to analyze a qa4sm netCDF output file and produce all relevant plots and maps.\r\n\r\nDevelopment Setup\r\n=================\r\n\r\nThe project was setup using `pyscaffold`_ and closely follows the recommendations.\r\n\r\nInstall Dependencies\r\n--------------------\r\n\r\nFor Development we recommend creating a ``conda`` environment.\r\n\r\n.. code::\r\n\r\n cd qa4sm-reader\r\n conda env create python=3.10 # create environment from requirements.rst\r\n conda activate qa4sm_reader\r\n conda env update -f environment.yml -n qa4sm_reader\r\n pip install -e .\r\n\r\nTo remove the environment again, run:\r\n\r\n.. code::\r\n\r\n conda deactivate\r\n conda env remove -n qa4sm_reader\r\n\r\nCode Formatting\r\n---------------\r\nTo apply pep8 conform styling to any changed files [we use `yapf`](https://github.com/google/yapf). The correct\r\nsettings are already set in `setup.cfg`. Therefore the following command\r\nshould be enough:\r\n\r\n.. code::\r\n\r\n yapf file.py --in-place\r\n\r\nTesting\r\n-------\r\n\r\nFor testing, we use ``py.test``:\r\n\r\n.. code::\r\n\r\n pytest\r\n\r\n\r\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``.\r\nFor some reasons, the dependencies are not installed as expected. To workaround, do:\r\n\r\n.. code::\r\n\r\n pip install pytest-cov\r\n\r\nThe files used for testing are included in this package. They are however subject to other `terms and conditions`_.\r\n\r\nKnown Issues\r\n------------\r\n\r\nNo known issues - please `open an issue`_ in case you come across a malfunctioning in the package.\r\n\r\n\r\n.. _qa4sm service: https://qa4sm.eu\r\n.. _pyscaffold: https://pyscaffold.org\r\n.. _pytest-runner: https://github.com/pytest-dev/pytest-runner\r\n.. _terms and conditions: https://qa4sm.eu/terms\r\n.. _open an issue: https://github.com/awst-austria/qa4sm-reader/issues\r\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.11",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f573f558d5ab95437afc2a3185af794af18b6157fb9f3433dbdf8680f38c6bf5",
"md5": "41861b14289b6badb2f785b217f453f2",
"sha256": "c733da56d3c344f32392457b0d1625aff9e5edb879312b9b4d32fa601874811d"
},
"downloads": -1,
"filename": "qa4sm_reader-0.11-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "41861b14289b6badb2f785b217f453f2",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.10",
"size": 110538,
"upload_time": "2025-02-06T14:04:38",
"upload_time_iso_8601": "2025-02-06T14:04:38.281854Z",
"url": "https://files.pythonhosted.org/packages/f5/73/f558d5ab95437afc2a3185af794af18b6157fb9f3433dbdf8680f38c6bf5/qa4sm_reader-0.11-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7c5d67c511c17c3f31f405b74bd8709a8f7ab29dbace41703e345de75762b99e",
"md5": "32f237bc9c5340074984eefc03aceddf",
"sha256": "d5fe6b848cbb8096f95868d8ce20405c966e6d24f75807e95d52cca3c9d95e31"
},
"downloads": -1,
"filename": "qa4sm_reader-0.11.tar.gz",
"has_sig": false,
"md5_digest": "32f237bc9c5340074984eefc03aceddf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 29469377,
"upload_time": "2025-02-06T14:04:42",
"upload_time_iso_8601": "2025-02-06T14:04:42.102492Z",
"url": "https://files.pythonhosted.org/packages/7c/5d/67c511c17c3f31f405b74bd8709a8f7ab29dbace41703e345de75762b99e/qa4sm_reader-0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-06 14:04:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qa4sm-reader"
}
