emissions-api
A solution that provides simple access to emissions data of climate-relevant gases.
https://github.com/emissions-api/emissions-api
Category: Emissions
Sub Category: Emission Observation and Modeling
Keywords
air-quality citizen-science copernicus emissions-api esa hacktoberfest python remote-sensing sentinel-5
Keywords from Contributors
geography geoprocessing sentinel5
Last synced: about 22 hours ago
JSON representation
Repository metadata
Web API to easily access satellite-based emission data
- Host: GitHub
- URL: https://github.com/emissions-api/emissions-api
- Owner: emissions-api
- License: mit
- Created: 2019-09-27T11:33:23.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T04:23:07.000Z (over 1 year ago)
- Last Synced: 2025-12-05T04:45:58.644Z (22 days ago)
- Topics: air-quality, citizen-science, copernicus, emissions-api, esa, hacktoberfest, python, remote-sensing, sentinel-5
- Language: Python
- Homepage: https://emissions-api.org
- Size: 6.65 MB
- Stars: 77
- Watchers: 4
- Forks: 11
- Open Issues: 23
- Releases: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Security: SECURITY.rst
README.rst
Emissions API
=============
.. image:: https://img.shields.io/travis/com/emissions-api/emissions-api?label=Docs
:target: https://docs.emissions-api.org
:alt: Documentation Status
.. image:: https://github.com/emissions-api/emissions-api/actions/workflows/main.yml/badge.svg
:target: https://github.com/emissions-api/emissions-api/actions/workflows/main.yml
:alt: Integration Test
This is the main repository for the `Emissions API `_.
If you just want to use Emissions API as a service, take a look at our `API documentation `_
or visit our `website `_ for additional information and examples.
Below you will find a small introduction about setting the services in this repository up for development.
If you want to take a deeper dive into this, you can take a look at the `documentation `_,
visit the `issues `_
or take a look into the `libraries and tools `_ we created around this project.
Installation
------------
To install the requirements execute
.. code-block:: bash
pip install -r requirements.txt
You might have to explicitly deal with C-dependencies like ``psycopg2`` yourself,
One way to do this is to use your corresponding system packages.
After that you can run the different services using
* **preprocess**\ : ``python -m emissionsapi.preprocess``
* **autoupdater**\ : ``python -m emissionsapi.autoupdater``
* **web**\ : ``python -m emissionsapi.web``
Configuration
-------------
Emissions API will look for configuration files in the following order:
* ``./emissionsapi.yml``
* ``~/emissionsapi.yml``
* ``/etc/emissionsapi.yml``
A configuration file template can be found at ``etc/emissionsapi.yml``.
To get started, just copy this to the main project directory and adjust the
values if the defaults do not work for you.
Database Setup
--------------
This project is using a `PostgreSQL `_ database with the `PostGIS `_ extension.
There is a simple ``docker-compose.yml`` file to make it easier to setup a
database for development.
Owner metadata
- Name: Emissions API
- Login: emissions-api
- Email:
- Kind: organization
- Description: Easy access to satellite-based emission data for everyone
- Website: https://emissions-api.org
- Location: Osnabrück, Germany
- Twitter: emissions_api
- Company:
- Icon url: https://avatars.githubusercontent.com/u/47664099?v=4
- Repositories: 7
- Last ynced at: 2023-03-03T02:45:25.788Z
- Profile URL: https://github.com/emissions-api
GitHub Events
Total
- Watch event: 2
Last Year
- Watch event: 2
Committers metadata
Last synced: 4 days ago
Total Commits: 381
Total Committers: 12
Avg Commits per committer: 31.75
Development Distribution Score (DDS): 0.745
Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| dependabot-preview[bot] | 2****] | 97 |
| Lars Kiesow | l****w@u****e | 88 |
| dependabot[bot] | 4****] | 86 |
| Sven Haardiek | s****n@h****e | 82 |
| Timo Brockmeyer | t****r@g****m | 6 |
| Max Brenner | x****b@g****m | 5 |
| David Dalisay | d****3@g****m | 4 |
| Sven Haardiek | s****k@i****e | 4 |
| Simon Kerssen | S****n@i****e | 3 |
| Björn | f****z@g****m | 3 |
| EmbeddedHenni | 4****i | 2 |
| TylerBird | t****0@g****m | 1 |
Committer domains:
- iotec-gmbh.de: 2
- haardiek.de: 1
- uos.de: 1
Issue and Pull Request metadata
Last synced: 2 months ago
Total issues: 64
Total pull requests: 493
Average time to close issues: 2 months
Average time to close pull requests: 22 days
Total issue authors: 7
Total pull request authors: 12
Average comments per issue: 1.3
Average comments per pull request: 0.7
Merged pull request: 332
Bot issues: 0
Bot pull requests: 332
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- lkiesow (34)
- shaardie (25)
- martincarapia (1)
- airqualityanthony (1)
- marcoarthur (1)
- benszau (1)
- tibroc (1)
Top Pull Request Authors
- dependabot[bot] (229)
- dependabot-preview[bot] (134)
- lkiesow (78)
- shaardie (64)
- benszau (6)
- tibroc (4)
- frangiz (3)
- brennerm (2)
- dalisaydavid (2)
- martincarapia (2)
- EmbeddedHenni (2)
- TylerBird (1)
Top Issue Labels
- good first issue (18)
- enhancement (16)
- documentation (6)
- bug (4)
- hacktoberfest (4)
- question (3)
- devops (2)
- tests (2)
- algorithm (1)
Top Pull Request Labels
- dependencies (370)
- bug (14)
- tests (11)
- documentation (9)
- enhancement (5)
- devops (1)
- security (1)
Dependencies
- Flask ==2.1.1
- GeoAlchemy2 ==0.10.0
- PyYAML ==6.0
- SQLAlchemy ==1.4.35
- alembic ==1.7.7
- connexion ==2.14.0
- geopandas ==0.10.2
- gunicorn ==20.1.0
- iso3166 ==2.0.2
- pandas ==1.3.5
- psycopg2 ==2.9.3
- python-dateutil ==2.8.2
- s5a ==0.4
- sentinel5dl ==1.1
- swagger-ui-bundle ==0.0.9
- GeoAlchemy2 *
- SQLAlchemy *
- connexion *
- geojson *
- geopandas *
- iso3166 *
- psycopg2 *
- python-dateutil *
- s5a *
- sentinel5dl *
- actions/checkout v2 composite
- github/codeql-action/analyze v1 composite
- github/codeql-action/autobuild v1 composite
- github/codeql-action/init v1 composite
- JamesIves/github-pages-deploy-action 3.7.1 composite
- actions/checkout v2 composite
- actions/setup-python v1 composite
- actions/checkout v2 composite
- actions/setup-python v1 composite
- actions/checkout v2 composite
- registry.hub.docker.com/postgis/postgis 12-master
Score: 7.090076835776092