Skip to content

Commit

Permalink
Refactor for image in README for PyPI
Browse files Browse the repository at this point in the history
  • Loading branch information
berrli committed Aug 8, 2024
1 parent 7f58234 commit 924832c
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 53 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<h1 style="text-align: center; font-size:1vw">Environmental Insights</h1>

<p align="center">
<img src="_static/environmental_insights.png" />
<img src="https://github.com/berrli/Environmental-Insights/raw/main/_static/environmental_insights.png" alt="Environmental Insights" />
</p>


Environmental Insights is a Python package for downloading and visualising air pollution concentration data in the UK and globally. Alongside the downloaded data, a set of functions have also been provided to manipulate the air pollution concentrations and explore air pollution futures. The Python package is a companion to the paper entitled "Environmental Insights: Democratizing Access to Ambient Air Pollution Data and Predictive Analytics with an Open-Source Python Package", with the following abstract:
\
Ambient air pollution is a pervasive issue with wide-ranging effects on human health, ecosystem vitality, and economic structures. Utilizing data on ambient air pollution concentrations, researchers can perform comprehensive analyses to uncover the multifaceted impacts of air pollution across society. To this end, we introduce Environmental Insights, an open-source Python package designed to democratize access to air pollution concentration data. This tool enables users to easily retrieve historical air pollution data and employ a Machine Learning model for forecasting potential future conditions. Moreover, Environmental Insights includes a suite of tools aimed at facilitating the dissemination of analytical findings and enhancing user engagement through dynamic visualizations. This comprehensive approach ensures that the package caters to the diverse needs of individuals looking to explore and understand air pollution trends and their implications.
Expand Down Expand Up @@ -82,6 +83,4 @@ The documentation for the project is included within the directory "Documentatio

## Pypip

Using `python -m build` will use the `pyproject.toml` file to locally build the package and store it within the `dist` directory. This can then be installed using `pip install dist/*.whl`. The final `dist` files can be uploaded to PyPI via twine.

## Conda
Using `python -m build` will use the `pyproject.toml` file to locally build the package and store it within the `dist` directory. This can then be installed using `pip install dist/*.whl`. The final `dist` files can be uploaded to PyPI via twine.
48 changes: 0 additions & 48 deletions meta.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "environmental-insights"
version = "0.1.0-beta"
version = "0.1.3_beta"
description = "A Python package for democratizing access to ambient air pollution data and predictive analytics."
readme = "README.md"
requires-python = ">=3.6"
Expand Down

0 comments on commit 924832c

Please sign in to comment.