titantuner


Nametitantuner JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryA package for tuning quality control parameters in titanlib
upload_time2023-11-28 20:32:41
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords meteorology observations quality control
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Titantuner
The titantuner is a web interface for tuning the many parameters of quality control methods in [titanlib](https://github.com/metno/titanlib).

![Example of titantuner](extras/image.jpg)

## Installation

Titantuner is available on pypi, and can be installed as follows:
```bash
pip3 install titantuner
```

To install from source, run the following in the root of this repository:
```bash
pip3 install .
```

## Running titantuner

```bash
titantuner [-p port]
```
This starts a webserver locally on your computer, making the titantuner available in the browser. Use `-p` to
speicy the port, otherwise it will appear on port 8081. Some sample data from Norwegian Synop stations are
provided by default.

Select the test you want to perform (SCT, Isolation, Buddy, Buddy event, SCT resistant, SCT dual, First
Guess), and set the test parameters in the UI. Then click on the update button (below the parameters)
to see the map showing the results of the tests.

## Running titantuner on your own data

Titantuner can parse data files organzed as follows:

```
lon;lat;elev;value
9.4023;61.5308;928;3.1
10.6878;60.0513;360;2.6
```

where lat and lon are in degrees, elev in meters, and value is the measurement. Each row represents one
observation, and each file represents observations for one time.

Supply a data directory when starting titantuner, which will load all data files in that directory:

```bash
titantuner -d <datadir>
```

## Using the autotune function (beta version)

Ongoing development. This function aims at finding optimized parameters for quality control methods. When
running the autotune function as it is, three parameters are optimized for the buddy check run on temperature
observations. These optimized parameters are the search radius, the minimum number of buddies a station can
have, and the variance threshold for flagging the station.

```bash
./titantuner/autotune.py obs_ta_20230924T12Z.txt
```

With obs_ta_20230924T12Z.txt containing 5 columns of data (temperature values) following this format:

```
lat;lon;elev;value;prid;dqc
61.1697;10.4107;205.0;13.70;5;0
58.2968;8.4620;70.0;14.60;5;7
```

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "titantuner",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "meteorology,observations,quality control",
    "author": "",
    "author_email": "Thomas Nipen <thomasnn@met.no>",
    "download_url": "",
    "platform": null,
    "description": "# Titantuner\nThe titantuner is a web interface for tuning the many parameters of quality control methods in [titanlib](https://github.com/metno/titanlib).\n\n![Example of titantuner](extras/image.jpg)\n\n## Installation\n\nTitantuner is available on pypi, and can be installed as follows:\n```bash\npip3 install titantuner\n```\n\nTo install from source, run the following in the root of this repository:\n```bash\npip3 install .\n```\n\n## Running titantuner\n\n```bash\ntitantuner [-p port]\n```\nThis starts a webserver locally on your computer, making the titantuner available in the browser. Use `-p` to\nspeicy the port, otherwise it will appear on port 8081. Some sample data from Norwegian Synop stations are\nprovided by default.\n\nSelect the test you want to perform (SCT, Isolation, Buddy, Buddy event, SCT resistant, SCT dual, First\nGuess), and set the test parameters in the UI. Then click on the update button (below the parameters)\nto see the map showing the results of the tests.\n\n## Running titantuner on your own data\n\nTitantuner can parse data files organzed as follows:\n\n```\nlon;lat;elev;value\n9.4023;61.5308;928;3.1\n10.6878;60.0513;360;2.6\n```\n\nwhere lat and lon are in degrees, elev in meters, and value is the measurement. Each row represents one\nobservation, and each file represents observations for one time.\n\nSupply a data directory when starting titantuner, which will load all data files in that directory:\n\n```bash\ntitantuner -d <datadir>\n```\n\n## Using the autotune function (beta version)\n\nOngoing development. This function aims at finding optimized parameters for quality control methods. When\nrunning the autotune function as it is, three parameters are optimized for the buddy check run on temperature\nobservations. These optimized parameters are the search radius, the minimum number of buddies a station can\nhave, and the variance threshold for flagging the station.\n\n```bash\n./titantuner/autotune.py obs_ta_20230924T12Z.txt\n```\n\nWith obs_ta_20230924T12Z.txt containing 5 columns of data (temperature values) following this format:\n\n```\nlat;lon;elev;value;prid;dqc\n61.1697;10.4107;205.0;13.70;5;0\n58.2968;8.4620;70.0;14.60;5;7\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A package for tuning quality control parameters in titanlib",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "meteorology",
        "observations",
        "quality control"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b16a0f8340028587fc8ee40152c6f641fee66ae934a3e7ca88e2ece83b66395",
                "md5": "b98ebb1c3c2727fd6e0788244d213cc1",
                "sha256": "cdf2d4d53a33baf566d364f068f333241f06d88f0ef960394b63188f02c2db76"
            },
            "downloads": -1,
            "filename": "titantuner-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b98ebb1c3c2727fd6e0788244d213cc1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 20189,
            "upload_time": "2023-11-28T20:32:41",
            "upload_time_iso_8601": "2023-11-28T20:32:41.216290Z",
            "url": "https://files.pythonhosted.org/packages/3b/16/a0f8340028587fc8ee40152c6f641fee66ae934a3e7ca88e2ece83b66395/titantuner-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-28 20:32:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "titantuner"
}
Elapsed time: 0.14619s