Skip to content

Commit e2d98c6

Browse files
authored
doc: Update README and add reference to vision/roadmap project (#452)
1 parent 67fd7fe commit e2d98c6

File tree

2 files changed

+13
-48
lines changed

2 files changed

+13
-48
lines changed

README.rst

Lines changed: 10 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -13,46 +13,10 @@ converting weather data (like wind speeds, solar influx) into energy systems dat
1313
It is designed to be lightweight, keeping computing resource requirements (CPU, RAM) usage low.
1414
It is therefore well suited to be used with big weather datasets.
1515

16-
.. atlite is designed to be modular, so that it can work with any weather
17-
.. datasets. It currently has modules for the following datasets:
18-
19-
.. * `NCEP Climate Forecast System <http://rda.ucar.edu/datasets/ds094.1/>`_ hourly
20-
.. historical reanalysis weather data available on a 0.2 x 0.2 degree global grid
21-
.. * `ECMWF ERA5
22-
.. <https://software.ecmwf.int/wiki/display/CKB/ERA5+data+documentation>`_ hourly
23-
.. historical reanalysis weather data on an approximately 0.25 x 0.25 deg global
24-
.. grid
25-
.. * `EURO-CORDEX Climate Change Projection <http://www.euro-cordex.net/>`_
26-
.. three-hourly up until 2100, available on a 0.11 x 0.11 degree grid for Europe
27-
.. * `CMSAF SARAH-2
28-
.. <https://wui.cmsaf.eu/safira/action/viewDoiDetails?acronym=SARAH_V002>`_
29-
.. half-hourly historical surface radiation on a 0.05 x 0.05 deg grid available
30-
.. for Europe and Africa (automatically interpolated to a 0.2 deg grid and
31-
.. combined with ERA5 temperature).
32-
33-
3416
atlite can process the following weather data fields and can convert them into following power-system relevant time series for any subsets of a full weather database.
3517

3618
.. image:: doc/workflow_chart.png
3719

38-
.. * Temperature
39-
.. * Downward short-wave radiation
40-
.. * Upward short-wave radiation
41-
.. * Wind
42-
.. * Runoff
43-
.. * Surface roughness
44-
.. * Height maps
45-
.. * Soil temperature
46-
.. * Dewpoint temperature
47-
48-
49-
.. * Wind power generation for a given turbine type
50-
.. * Solar PV power generation for a given panel type
51-
.. * Solar thermal collector heat output
52-
.. * Hydroelectric inflow (simplified)
53-
.. * Heating demand (based on the degree-day approximation)
54-
55-
5620
atlite was initially developed by the `Renewable Energy Group
5721
<https://fias.uni-frankfurt.de/physics/schramm/renewable-energy-system-and-network-analysis/>`_
5822
at `FIAS <https://fias.uni-frankfurt.de/>`_ to carry out simulations
@@ -63,6 +27,16 @@ Research Initiative
6327
<http://forschung-stromnetze.info/projekte/grundlagen-und-konzepte-fuer-effiziente-dezentrale-stromnetze/>`_.
6428

6529

30+
With `atlite` we want to provide an interface between the meteorological and energy systems modelling communities.
31+
32+
Traditionally the MET and ESM communities have not been interacting much.
33+
The outputs and learning of one community were only slowly adapted into the other community.
34+
35+
With `atlite` we want bridge between the communities:
36+
We want to make it easy to use and integrate outputs of the MET communities into energy system models, by offering standardized ways of accessing weather/climate datasets and converting them to weather-dependent inputs for ESMs.
37+
38+
For major next development goals, consult our `vision and roadmap project <https://github.com/orgs/PyPSA/projects/12/views/1>`_ or check our list of possible `enhancements <https://github.com/PyPSA/atlite/issues/?q=is%3Aissue%20state%3Aopen%20label%3A%22type%3A%20enhancement%22>`_.
39+
6640
Installation
6741
============
6842

@@ -93,18 +67,6 @@ to install the most recent upstream version from GitHub
9367
9468
Documentation
9569
===============
96-
.. * Install atlite from conda-forge or pypi.
97-
.. * Download one of the weather datasets listed above (ERA5 is downloaded
98-
.. automatically on-demand after the ECMWF
99-
.. `cdsapi<https://cds.climate.copernicus.eu/api-how-to>` client is
100-
.. properly installed)
101-
.. * Create a cutout, i.e. a geographical rectangle and a selection of
102-
.. times, e.g. all hours in 2011 and 2012, to narrow down the scope -
103-
.. see `examples/create_cutout.py <examples/create_cutout.py>`_
104-
.. * Select a sparse matrix of the geographical points inside the cutout
105-
.. you want to aggregate for your time series, and pass it to the
106-
.. appropriate converter function - see `examples/ <examples/>`_
107-
10870

10971
Please check the `documentation <https://atlite.readthedocs.io/en/latest>`_.
11072

doc/contributing.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ share news, or chat with the community.
2020
You are invited to submit pull requests / issues to our
2121
`Github repository <https://github.com/pypsa/atlite>`_.
2222

23+
For major next development goals, you can consult our `vision and roadmap project <https://github.com/orgs/PyPSA/projects/12/views/1>`_
24+
or check the list of possible `enhancements <https://github.com/PyPSA/atlite/issues/?q=is%3Aissue%20state%3Aopen%20label%3A%22type%3A%20enhancement%22>`_.
25+
2326
For linting, formatting and checking your code contributions
2427
against our guidelines (e.g. we use `Black <https://github.com/psf/black>`_ as code style
2528
and aim for `REUSE compliance <https://reuse.software/>`_,

0 commit comments

Comments
 (0)