diff --git a/README.md b/README.md index 5057c355..c2ce81d4 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,20 @@ +test + # Quartz Solar Forecast + [![All Contributors](https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat-square)](#contributors-) + ![image](https://github.com/user-attachments/assets/6563849b-b355-4842-93e4-61c15a9a9ebf) [![tags badge](https://img.shields.io/github/v/tag/openclimatefix/open-source-quartz-solar-forecast?include_prereleases&sort=semver&color=FFAC5F)](https://github.com/openclimatefix/open-source-quartz-solar-forecast/tags) [![pypi badge](https://img.shields.io/pypi/v/quartz-solar-forecast?&color=07BCDF)](https://pypi.org/project/quartz-solar-forecast/) -[![ease of contribution: easy](https://img.shields.io/badge/ease%20of%20contribution:%20easy-32bd50)](https://github.com/openclimatefix/ocf-meta-repo?tab=readme-ov-file#overview-of-ocfs-nowcasting-repositories) +[![ease of contribution: easy](https://img.shields.io/badge/ease%20of%20contribution:%20easy-32bd50)](https://github.com/openclimatefix/ocf-meta-repo?tab=readme-ov-file#overview-of-ocfs-nowcasting-repositories) [![Python package tests](https://github.com/openclimatefix/open-source-quartz-solar-forecast/actions/workflows/pytest.yaml/badge.svg)](https://github.com/openclimatefix/open-source-quartz-solar-forecast/actions/workflows/pytest.yaml) +test The aim of the project is to build an open source PV forecast that is free and easy to use. The forecast provides the expected generation in `kw` for 0 to 48 hours for a single PV site. @@ -22,7 +27,6 @@ Want to learn more about the project? We've presented Quartz Solar Forecast at t - **LF Energy 2024**: Exploring Open Quartz's developments - new models, inverter APIs, and our Open Source journey at Open Climate Fix [Watch the talk](https://www.youtube.com/watch?v=YTaq41ztEDg) - The current model uses GFS or ICON NWPs to predict the solar generation at a site ```python @@ -79,12 +83,11 @@ This can solve the [bug: \_\_\_kmpc_for_static_fini](https://github.com/openclim ### Logging -The package logs when `run_forecast` is used. This is useful for OCF to determine how the package is being used +The package logs when `run_forecast` is used. This is useful for OCF to determine how the package is being used and how we can make improvements in the future. Note that any latitudes and longitudes are rounded to 2 decimals places in order to anonymize the data. If you would like to disable this logging, you can do so by setting the environment variable `QUARTZ_SOLAR_FORECAST_LOGGING` to `False`. - ## Model Two models are currently available to make predictions. @@ -227,7 +230,7 @@ Start the frontend (port 5137): `npm install` `npm run dev` -There is also a steamlit dashboard in `dashboards/dashboard_2` that can be used. +There is also a steamlit dashboard in `dashboards/dashboard_2` that can be used. ## Global Model