Code Monkey home page Code Monkey logo

noaa's Introduction

NOAA Climate Data Online SDK for Python

Python API for NOAA climate data.

Getting started

Prerequisites

To use this interface you need:

  • python 3.7+

For development you additionaly need:

  • sphinx

Installing

Intall using pip from source:

Install latest available source using

python -m pip install git+https://github.com/exTerEX/noaa.git#egg=noaa

Or install specific version (tag, commit, branch) available using

python -m pip install git+https://github.com/exTerEX/noaa.git@<branch/commit hash/tag>#egg=noaa

where <branch/commit hash/tag> is changed out for a specific branch (e.g. main, development), commit hash (e.g. 86ba995, 770f02), or tag (e.g. 0.1.0-alpha, 1.17.6)

Install using pip from tarball:

Install latest available source using

python -m pip install git+https://github.com/exTerEX/noaa/tarball/main

Usage

Below is a simple example on how to use this API. Get a token from NOAA and input it into where <token> in the example below.

from noaa.climate import API

noaaobj = API("<token>")

print(noaaobj.get_datasets())
print(noaaobj.get_data(
        dataset_id = "GSOM",
        start_date="1970-10-03",
        end_date="2012-09-10")
)
print(noaaobj.get_data_categories())
print(noaaobj.get_data_types())
print(noaaobj.get_locations())
print(noaaobj.get_stations())

See documentation for an in-depth explanation of input values.

Running tests

Run the tests in the CMD using the line under, with a valid token.

python tests/climate.py <token>

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

This project use PEP440 for versioning. For the versions available, see the tags on this repository.

Authors

  • Andreas Sagen - Initial contributer

License

This project is licensed under the MIT. For more details see LICENSE.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.