{"id":15360425,"url":"https://github.com/sarthakjariwala/nrel_dev_api","last_synced_at":"2025-04-15T08:19:18.811Z","repository":{"id":37792843,"uuid":"323205543","full_name":"SarthakJariwala/nrel_dev_api","owner":"SarthakJariwala","description":"Python API to access data and analysis services from NREL (National Renewable Energy Lab)","archived":false,"fork":false,"pushed_at":"2023-01-20T19:02:49.000Z","size":1312,"stargazers_count":4,"open_issues_count":20,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-15T08:18:54.712Z","etag":null,"topics":["nrel","nsrdb","pvwatts","python-api","solar"],"latest_commit_sha":null,"homepage":"https://nrel-dev-api.readthedocs.io/en/latest","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SarthakJariwala.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.rst","code_of_conduct":"CODE_OF_CONDUCT.rst","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-21T01:57:26.000Z","updated_at":"2024-03-12T07:48:27.000Z","dependencies_parsed_at":"2023-02-12T04:32:09.079Z","dependency_job_id":null,"html_url":"https://github.com/SarthakJariwala/nrel_dev_api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":"fastai/nbdev_template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SarthakJariwala%2Fnrel_dev_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SarthakJariwala%2Fnrel_dev_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SarthakJariwala%2Fnrel_dev_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SarthakJariwala%2Fnrel_dev_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SarthakJariwala","download_url":"https://codeload.github.com/SarthakJariwala/nrel_dev_api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249031824,"owners_count":21201358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nrel","nsrdb","pvwatts","python-api","solar"],"created_at":"2024-10-01T12:49:57.233Z","updated_at":"2025-04-15T08:19:18.790Z","avatar_url":"https://github.com/SarthakJariwala.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"NREL Dev API\n============\n\n|PyPI| |Status| |Python Version| |License|\n\n|Read the Docs| |Tests| |Codecov| |pre-commit| |Black|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/nrel_dev_api.svg\n   :target: https://pypi.org/project/nrel_dev_api/\n   :alt: PyPI\n.. |Status| image:: https://img.shields.io/pypi/status/nrel_dev_api.svg\n   :target: https://pypi.org/project/nrel_dev_api/\n   :alt: Status\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/nrel_dev_api\n   :target: https://pypi.org/project/nrel_dev_api\n   :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/nrel_dev_api\n   :target: https://opensource.org/licenses/Apache-2.0\n   :alt: License\n.. |Read the Docs| image:: https://img.shields.io/readthedocs/nrel_dev_api/latest.svg?label=Read%20the%20Docs\n   :target: https://nrel_dev_api.readthedocs.io/\n   :alt: Read the documentation at https://nrel_dev_api.readthedocs.io/\n.. |Tests| image:: https://github.com/SarthakJariwala/nrel_dev_api/workflows/Tests/badge.svg\n   :target: https://github.com/SarthakJariwala/nrel_dev_api/actions?workflow=Tests\n   :alt: Tests\n.. |Codecov| image:: https://codecov.io/gh/SarthakJariwala/nrel_dev_api/branch/main/graph/badge.svg\n   :target: https://codecov.io/gh/SarthakJariwala/nrel_dev_api\n   :alt: Codecov\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :target: https://github.com/pre-commit/pre-commit\n   :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n   :alt: Black\n\n\nAccess data and analysis services that NREL (National Renewable Energy Lab) provides using a python API.\n\n.. note:: In order to use `nrel_dev_api`, you will need an API key from NREL. You can get one `here \u003chttps://developer.nrel.gov/signup/\u003e`_.\n\n\nInstallation\n------------\n\nYou can install *nrel_dev_api* via pip_ from PyPI_:\n\n.. code:: console\n\n   pip install -U nrel_dev_api\n\n\nUsage\n-----\n\nSet API Key\n+++++++++++\n\nGlobally set your NREL developer API key.\n\n.. code:: python\n\n   from nrel_dev_api import set_nrel_api_key\n\n   set_nrel_api_key(NREL_API_KEY)\n\n\nAccesing Solar Data and Resources\n+++++++++++++++++++++++++++++++++\n\n++++++++++\nPVWatts V6\n++++++++++\n\nEstimate the energy production of grid-connected photovoltaic (PV) energy systems using NREL's PVWatts V6 API based on a few simple location and system inputs.\n\n.. code:: python\n\n   from nrel_dev_api.solar import PVWattsV6\n\n   # create PVWattsV6 class and pass the necessary location and system inputs\n   pvwatts_v6 = PVWattsV6(system_capacity=4,\n                        address=\"Seattle, WA\",\n                        azimuth=180,\n                        tilt=40,\n                        array_type=1,\n                        module_type=1,\n                        losses=10\n                        )\n\n   # You can also view the details about the station.\n   pvwatts_v6.station_info\n\n+++++++++++++++++++++++++++++++++++++++++++++++\nQuery National Solar Radiation Database (NSRDB)\n+++++++++++++++++++++++++++++++++++++++++++++++\n\n.. code:: python\n\n   from nrel_dev_api.solar import NSRDB_DataQuery\n\n   nsrdb_data_query = NSRDB_DataQuery(api_key=NREL_API_KEY, wkt=\"POINT(91.287 23.832)\")\n\n   # check the outputs\n   nsrdb_data_query.outputs\n\n++++++++++++++++++++++\nData on Solar Resource\n++++++++++++++++++++++\n\nGet solar resource data for a specific location\n\n.. code:: python\n\n   from nrel_dev_api.solar import SolarResourceData\n\n   # get solar resource data for a specific latitude and longitude\n   solar_resource_data = SolarResourceData(api_key=NREL_API_KEY, lat=40, lon=-105)\n\n   # the output data is stored in the outputs attribute\n   solar_resource_data.outputs\n\n++++++++++++++\nSolar Datasets\n++++++++++++++\n\nGet information on the closest climate data for a location.\n\n.. code:: python\n\n   from nrel_dev_api.solar import SolarDatasetQuery\n\n   # create a dataset query class\n   solar_dataset_query = SolarDatasetQuery(api_key=NREL_API_KEY, address=\"San Francisco, CA\")\n\n   # get the output\n   solar_dataset_query.outputs\n\n\nContributing\n------------\n\nContributions are very welcome.\nTo learn more, see the `Contributor Guide`_.\n\n\nLicense\n-------\n\nDistributed under the terms of the `Apache 2.0 license`_,\n*nrel_dev_api* is free and open source software.\n\n\nIssues\n------\n\nIf you encounter any problems,\nplease `file an issue`_ along with a detailed description.\n\n\nCredits\n-------\n\nThis project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.\n\n.. _@cjolowicz: https://github.com/cjolowicz\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _Apache 2.0 license: https://opensource.org/licenses/Apache-2.0\n.. _PyPI: https://pypi.org/\n.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n.. _file an issue: https://github.com/SarthakJariwala/nrel_dev_api/issues\n.. _pip: https://pip.pypa.io/\n.. github-only\n.. _Contributor Guide: CONTRIBUTING.rst\n.. _Usage: https://nrel_dev_api.readthedocs.io/en/latest/usage.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsarthakjariwala%2Fnrel_dev_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsarthakjariwala%2Fnrel_dev_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsarthakjariwala%2Fnrel_dev_api/lists"}