| Name | qa4sm-reader JSON |
| Version |
0.9
JSON |
| download |
| home_page | |
| Summary | Processes output of qa4sm.eodc.eu (NetCDF file), creating plots and providing the data in other formats. |
| upload_time | 2023-03-14 12:48:22 |
| maintainer | |
| docs_url | None |
| author | TU Wien |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
============
qa4sm_reader
============
.. image:: https://github.com/TUW-GEO/qa4sm-reader/workflows/tests/badge.svg
:target: https://github.com/TUW-GEO/qa4sm-reader/actions?query=workflow%3Atests
.. image:: https://coveralls.io/repos/github/awst-austria/qa4sm-reader/badge.svg?branch=master
:target: https://coveralls.io/github/awst-austria/qa4sm-reader?branch=master
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 (not yet tough, see development):
.. 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 # create environment from requirements.rst
conda activate qa4sm-reader
python setup.py develop # Links the code to the environment
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": "",
"name": "qa4sm-reader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "TU Wien",
"author_email": "remote.sensing@geo.tuwien.ac.at",
"download_url": "https://files.pythonhosted.org/packages/d7/17/a342487ae7574d3981f016c9a80226005254802c18e58a8d7390d4e13d8b/qa4sm_reader-0.9.tar.gz",
"platform": null,
"description": "============\nqa4sm_reader\n============\n\n.. image:: https://github.com/TUW-GEO/qa4sm-reader/workflows/tests/badge.svg\n :target: https://github.com/TUW-GEO/qa4sm-reader/actions?query=workflow%3Atests\n\n.. image:: https://coveralls.io/repos/github/awst-austria/qa4sm-reader/badge.svg?branch=master\n :target: https://coveralls.io/github/awst-austria/qa4sm-reader?branch=master\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 (not yet tough, see development):\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 # create environment from requirements.rst\n conda activate qa4sm-reader\n python setup.py develop # Links the code to the environment\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.9",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7763839df43797cffdc78e57a281a744226c4d45a47ada5f82afcb550529f69b",
"md5": "c66e33f63aad695e91dad62c60760c72",
"sha256": "67384041c15a7eaf6f756e4b79c528024be1990890d76611e9afa34d9b6f2468"
},
"downloads": -1,
"filename": "qa4sm_reader-0.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c66e33f63aad695e91dad62c60760c72",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 53717,
"upload_time": "2023-03-14T12:48:19",
"upload_time_iso_8601": "2023-03-14T12:48:19.515635Z",
"url": "https://files.pythonhosted.org/packages/77/63/839df43797cffdc78e57a281a744226c4d45a47ada5f82afcb550529f69b/qa4sm_reader-0.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d717a342487ae7574d3981f016c9a80226005254802c18e58a8d7390d4e13d8b",
"md5": "e2d023d57d270f5492c97b7d89f25e32",
"sha256": "85c9c4611f7cab7a838c0e01fd806df0725d578624394e16b7b2880d74117ecb"
},
"downloads": -1,
"filename": "qa4sm_reader-0.9.tar.gz",
"has_sig": false,
"md5_digest": "e2d023d57d270f5492c97b7d89f25e32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 28716352,
"upload_time": "2023-03-14T12:48:22",
"upload_time_iso_8601": "2023-03-14T12:48:22.588724Z",
"url": "https://files.pythonhosted.org/packages/d7/17/a342487ae7574d3981f016c9a80226005254802c18e58a8d7390d4e13d8b/qa4sm_reader-0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-14 12:48:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "qa4sm-reader"
}
