inmet-ws


Nameinmet-ws JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/victorbenezoli/inmet-stations
SummaryThis package aims to make it easier to find the weather station in the INMET database closest to the desired location.
upload_time2025-10-06 18:44:05
maintainerNone
docs_urlNone
authorVictor Benezoli
requires_python<3.14,>=3.12
licenseMIT
keywords weather meteorology inmet geospatial
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img src="https://raw.githubusercontent.com/victorbenezoli/iws/main/logo-horizontal.png" alt="IWS Logo" width="400"/>
</p>

<h1 align="center">IWS - Inmet Weather Stations</h1>

<p align="center">
  Python package for processing and analyzing data from INMET weather stations.
</p>

<p align="center">
  <!-- Inline badges -->
  <img src="https://img.shields.io/badge/python-3.12%2B-blue" alt="Python 3.12+"/>
  <img src="https://img.shields.io/badge/license-MIT-green" alt="License: MIT"/>
  <img src="https://img.shields.io/badge/status-active-success" alt="Status: Active"/>
  <img src="https://img.shields.io/badge/docs-available-blueviolet" alt="Docs: Available"/>
</p>

---

## 📦 Installation

Install the package using pip:

```bash
pip install iws
```

---

## 🚀 Basic Usage

```python
from iws import InmetStations, get_climate_data, GeoCoordinates, Distance

stations = InmetStations()

# List available stations
print(stations.list())

# Retrieve data from a specific station
station = stations["A001"]  # Replace "A001" with the desired station code
print(station)
data = get_climate_data(station=station, start_date="2023-01-01", end_date="2023-12-31")
print(data.head())

# Find the three nearest operating stations to given coordinates
coords = GeoCoordinates(latitude=-23.55052, longitude=-46.633308, n_nearest=3, only_operating=True)
nearest_stations = stations.find_nearest(coords)
print(nearest_stations)

# Find the stations around given coordinates within a 50 km radius
nearby_stations = stations.find_around(coords, maximum_distance=Distance(50, "km"))
print(nearby_stations)
```

---

## 🌦️ Features

- 📊 Download and process historical data from INMET
- 🌍 Support for multiple weather stations
- ⚡ Optimized functions for analysis with pandas and numpy
- 📈 Ready for integration with notebooks and dashboards

---

## 📚 Documentation

- **[API Reference](https://github.com/victorbenezoli/iws/wiki/API-Reference)** - Complete API documentation
- **[Project Wiki](https://github.com/victorbenezoli/iws/wiki)** - General information and guides

---

## 🤝 Contributing

Contributions are welcome!
1. Fork the repository
2. Create a branch (`git checkout -b feature/new-feature`)
3. Commit your changes (`git commit -m 'Add new feature'`)
4. Push to the branch (`git push origin feature/new-feature`)
5. Open a Pull Request

Please ensure the branch name follows the patterns:
- `feature/your-feature-name` for new features
- `bugfix/your-bugfix-name` for bug fixes
- `hotfix/your-hotfix-name` for urgent fixes
- `docs/your-docs-update` for documentation updates
- `improvement/your-improvement-name` for code improvements

---

## 📜 License

Distributed under the MIT License.
See the `LICENSE` file for more information.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/victorbenezoli/inmet-stations",
    "name": "inmet-ws",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.12",
    "maintainer_email": null,
    "keywords": "weather, meteorology, inmet, geospatial",
    "author": "Victor Benezoli",
    "author_email": "victorbenezoli@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/96/df/5bf56898598e832be335656b7e7b5b4cf3fbaddea160ef0b4333edf1ee28/inmet_ws-0.2.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img src=\"https://raw.githubusercontent.com/victorbenezoli/iws/main/logo-horizontal.png\" alt=\"IWS Logo\" width=\"400\"/>\n</p>\n\n<h1 align=\"center\">IWS - Inmet Weather Stations</h1>\n\n<p align=\"center\">\n  Python package for processing and analyzing data from INMET weather stations.\n</p>\n\n<p align=\"center\">\n  <!-- Inline badges -->\n  <img src=\"https://img.shields.io/badge/python-3.12%2B-blue\" alt=\"Python 3.12+\"/>\n  <img src=\"https://img.shields.io/badge/license-MIT-green\" alt=\"License: MIT\"/>\n  <img src=\"https://img.shields.io/badge/status-active-success\" alt=\"Status: Active\"/>\n  <img src=\"https://img.shields.io/badge/docs-available-blueviolet\" alt=\"Docs: Available\"/>\n</p>\n\n---\n\n## \ud83d\udce6 Installation\n\nInstall the package using pip:\n\n```bash\npip install iws\n```\n\n---\n\n## \ud83d\ude80 Basic Usage\n\n```python\nfrom iws import InmetStations, get_climate_data, GeoCoordinates, Distance\n\nstations = InmetStations()\n\n# List available stations\nprint(stations.list())\n\n# Retrieve data from a specific station\nstation = stations[\"A001\"]  # Replace \"A001\" with the desired station code\nprint(station)\ndata = get_climate_data(station=station, start_date=\"2023-01-01\", end_date=\"2023-12-31\")\nprint(data.head())\n\n# Find the three nearest operating stations to given coordinates\ncoords = GeoCoordinates(latitude=-23.55052, longitude=-46.633308, n_nearest=3, only_operating=True)\nnearest_stations = stations.find_nearest(coords)\nprint(nearest_stations)\n\n# Find the stations around given coordinates within a 50 km radius\nnearby_stations = stations.find_around(coords, maximum_distance=Distance(50, \"km\"))\nprint(nearby_stations)\n```\n\n---\n\n## \ud83c\udf26\ufe0f Features\n\n- \ud83d\udcca Download and process historical data from INMET\n- \ud83c\udf0d Support for multiple weather stations\n- \u26a1 Optimized functions for analysis with pandas and numpy\n- \ud83d\udcc8 Ready for integration with notebooks and dashboards\n\n---\n\n## \ud83d\udcda Documentation\n\n- **[API Reference](https://github.com/victorbenezoli/iws/wiki/API-Reference)** - Complete API documentation\n- **[Project Wiki](https://github.com/victorbenezoli/iws/wiki)** - General information and guides\n\n---\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome!\n1. Fork the repository\n2. Create a branch (`git checkout -b feature/new-feature`)\n3. Commit your changes (`git commit -m 'Add new feature'`)\n4. Push to the branch (`git push origin feature/new-feature`)\n5. Open a Pull Request\n\nPlease ensure the branch name follows the patterns:\n- `feature/your-feature-name` for new features\n- `bugfix/your-bugfix-name` for bug fixes\n- `hotfix/your-hotfix-name` for urgent fixes\n- `docs/your-docs-update` for documentation updates\n- `improvement/your-improvement-name` for code improvements\n\n---\n\n## \ud83d\udcdc License\n\nDistributed under the MIT License.\nSee the `LICENSE` file for more information.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "This package aims to make it easier to find the weather station in the INMET database closest to the desired location.",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/victorbenezoli/inmet-stations",
        "Repository": "https://github.com/victorbenezoli/inmet-stations"
    },
    "split_keywords": [
        "weather",
        " meteorology",
        " inmet",
        " geospatial"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f91945eae40591a4460b97f19407f49ca818cfe99c09be51b1d3f37fdff7ddcd",
                "md5": "fba992b930202acb12d65a0f749ff449",
                "sha256": "bf0816d835d33f04d5a2c74d265842022442488d2563784a882e42e7bd908af2"
            },
            "downloads": -1,
            "filename": "inmet_ws-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fba992b930202acb12d65a0f749ff449",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.12",
            "size": 16439,
            "upload_time": "2025-10-06T18:44:03",
            "upload_time_iso_8601": "2025-10-06T18:44:03.796819Z",
            "url": "https://files.pythonhosted.org/packages/f9/19/45eae40591a4460b97f19407f49ca818cfe99c09be51b1d3f37fdff7ddcd/inmet_ws-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96df5bf56898598e832be335656b7e7b5b4cf3fbaddea160ef0b4333edf1ee28",
                "md5": "2e6fd98795be8cb808dc61b4f7d54716",
                "sha256": "24cecacb7031fb728df9c2fe03bb1237b2ceb18238008432cb717dafd80026b3"
            },
            "downloads": -1,
            "filename": "inmet_ws-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e6fd98795be8cb808dc61b4f7d54716",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.12",
            "size": 12853,
            "upload_time": "2025-10-06T18:44:05",
            "upload_time_iso_8601": "2025-10-06T18:44:05.228789Z",
            "url": "https://files.pythonhosted.org/packages/96/df/5bf56898598e832be335656b7e7b5b4cf3fbaddea160ef0b4333edf1ee28/inmet_ws-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-06 18:44:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "victorbenezoli",
    "github_project": "inmet-stations",
    "github_not_found": true,
    "lcname": "inmet-ws"
}
        
Elapsed time: 1.85264s