Skip to content

Commit 27e3481

Browse files
authored
Cleanup docs (#44)
* update readme * added dashboard-2025.md * added dashboard-2024.md * added dashboard-2023.md * added dashboard-2022.md and dashboard-2021.md * fixed download links * formatted releases.md * update changes * updated about.md * fixed logo
1 parent 3c24b98 commit 27e3481

16 files changed

+735
-594
lines changed

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,20 @@ Contributions are welcome. Feel free to open a pull request with changes.
1010

1111
## Running it Locally
1212

13-
It can be helpful to preview changes on your computer before opening a pull request. *ROOCS website* uses the [Jekyll static site generator](http://jekyllrb.com/). After forking or cloning the repository, perform the following steps to generate the site and preview it:
13+
It can be helpful to preview changes on your computer before opening a pull request. *ROOCS website* uses the [MkDocs static site generator](https://www.mkdocs.org/). After forking or cloning the repository, perform the following steps to generate the site and preview it:
1414

15-
- Make sure you have ruby installed on your computer. See https://www.ruby-lang.org/en/downloads/
16-
- `bundle install`
17-
- `bundle exec jekyll serve`
18-
- Point your browser at http://127.0.0.1:4000/
15+
````
16+
conda env create
1917
20-
### Use Docker as build environment
18+
conda activate roocs
2119
22-
Run this once to generate Gemfile.lock:
23-
```
24-
docker-compose run jekyll bundle install
25-
```
20+
mkdocs build
2621
27-
Build image:
28-
```
29-
docker-compose build
30-
```
22+
mkdocs serve
3123
32-
Start service:
33-
```
34-
docker-compose up
24+
Open browser: http://127.0.0.1:8000
3525
```
3626
37-
Open http://localhost:4000
38-
3927
## Deployment
4028
4129
Pull requests merged to the main branch are automatically deployed to the production website.

docs/about.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,33 @@
1-
# What is the project about?
1+
# 🧊 About the Project
22

3-
We provide *data-aware* processing services of climate projections (like CMIP6 global data)
4-
for the [Climate Data Store](https://cds.climate.copernicus.eu) (CDS).
3+
We provide **data-aware processing services** for climate projections such as **CMIP6** global datasets, integrated into the [Climate Data Store (CDS)](https://cds.climate.copernicus.eu/).
54

6-
## Who is working on the project?
5+
These services support scalable, efficient access and transformation of large climate datasets, enabling downstream applications and research.
76

8-
* [IPSL](https://www.ipsl.fr/en)
9-
* [DKRZ](https://www.dkrz.de/)
7+
---
108

11-
## Which projects and groups do we work with?
9+
## 👥 Who’s Involved?
1210

13-
* [STFC/CEDA](http://www.ceda.ac.uk/)
14-
* [ESGF](https://esgf.llnl.gov/)
15-
* [Ouranos](https://github.com/Ouranosinc)
16-
* [CRIM](https://github.com/crim-ca)
17-
* [GeoPython](https://github.com/geopython)
11+
![IPSL logo](images/ipsl.png){ width=100 }
12+
[**IPSL** – Institut Pierre-Simon Laplace](https://www.ipsl.fr/en)
1813

19-
## Future developments
14+
![DKRZ logo](images/dkrz.svg){ width=100 }
15+
[**DKRZ** – Deutsches Klimarechenzentrum](https://www.dkrz.de/)
2016

21-
Led by [STFC/CEDA](http://www.ceda.ac.uk/) and [DKRZ](https://www.dkrz.de/) further development on roocs
22-
happens to make the roocs processing services available for [ESGF](https://esgf.llnl.gov/).
17+
---
18+
19+
## 🤝 Collaborating Organizations
20+
21+
We actively work with several partners and community groups:
22+
23+
- 🛰️ [STFC/CEDA](http://www.ceda.ac.uk/)
24+
- 🌍 [ESGF](https://esgf.llnl.gov/)
25+
- 🌦️ [Ouranos](https://github.com/Ouranosinc)
26+
- 🧠 [CRIM](https://github.com/crim-ca)
27+
- 🐍 [GeoPython](https://github.com/geopython)
28+
29+
---
30+
31+
## 🚀 Future Development
32+
33+
Ongoing developments are driven by [STFC/CEDA](http://www.ceda.ac.uk/) and [DKRZ](https://www.dkrz.de/), focusing on integrating processing services into the [ESGF](https://esgf.llnl.gov/) infrastructure.

docs/changelog.md

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
# Changelog
2+
3+
## 0.17.2 – 2025-05-08
4+
5+
- Updated tests for **Atlas v2**.
6+
- Fixed dashboard for latest `bokeh >= 3.7`.
7+
8+
## 0.17.1 – 2025-05-06
9+
10+
- Fixed calendar bug for **proleptic Gregorian** calendar.
11+
12+
## 0.17.0 – 2025-04-29
13+
14+
- Added support for **Atlas v2** data.
15+
16+
## 0.16.1 – 2025-02-26
17+
18+
- Fixed smoke tests.
19+
- Added `beautifulsoup` to requirements.
20+
21+
## 0.16.0 – 2025-02-21
22+
23+
- Switched to **pooch** for test data management.
24+
- Modernized Python code and deployment.
25+
- Removed `roocs-utils`. Now requires:
26+
- `clisops >= 0.15.0`
27+
- `daops >= 0.14.0`
28+
- Replaced linting setup with **ruff**.
29+
- Changed default Git branch to `main`.
30+
31+
## 0.15.0 – 2024-11-20
32+
33+
- Improved decadal fixes for **proleptic Gregorian** calendar.
34+
- Provenance now includes local installation "site" name.
35+
- Fixed documentation links.
36+
37+
## 0.14.0 – 2024-10-22
38+
39+
- Added Docker image test step to CI.
40+
- Updated CI workflows and template:
41+
- New `CODE_OF_CONDUCT.rst`
42+
- Modernized Dockerfile
43+
- Documented all processes
44+
- Switched to `pyproject.toml` with `flit-core`
45+
- Adopted `src/` layout
46+
47+
## 0.13.1 – 2024-07-22
48+
49+
- Added process: **average over polygon**.
50+
- Updated **CDS domain**.
51+
52+
## 0.13.0 – 2024-02-06
53+
54+
- Added **subsetting support for Atlas v1** datasets.
55+
56+
## 0.12.2 – 2023-12-08
57+
58+
- Fixed `time_components` for **360-day calendar** compatibility.
59+
60+
## 0.12.1 – 2023-12-04
61+
62+
- Patched fill-value issue via updated `clisops`.
63+
- Added smoke test for fill-value handling.
64+
65+
## 0.12.0 – 2023-11-28
66+
67+
- Added **regridding operator** from `clisops`.
68+
- Added tests and smoke tests for regridding.
69+
- CI now uses Conda.
70+
71+
## 0.11.0 – 2023-11-09
72+
73+
- Added **weighted average** operator and WPS process.
74+
- Added WPS regridding process (dummy operator).
75+
- Updated to:
76+
- `pywps 4.6.0`
77+
- `clisops` and `daops` with decadal fixes
78+
- Dropped Python 3.8 support.
79+
80+
## 0.10.1 – 2023-07-20
81+
82+
- Updated fix application logic.
83+
- Fixed smoke tests for CMIP5.
84+
85+
## 0.10.0 – 2023-07-12
86+
87+
- Updated `concat` operator to optionally apply subsetting and averaging.
88+
- Applied CMIP6 decadal fixes directly (no ElasticSearch lookup).
89+
- Updated to `clisops 0.10.0`.
90+
91+
## 0.9.3 – 2023-05-16
92+
93+
- Added smoke tests for:
94+
- `c3s-ipcc-atlas`
95+
- `c3s-cmip6-decadal`
96+
- Updated `roocs` config for `c3s-ipcc-atlas`.
97+
98+
## 0.9.2 – 2023-02-02
99+
100+
- Updated to `roocs-utils` with `realization` dimension support.
101+
- Updated `concat` operator.
102+
103+
## 0.9.1 – 2022-12-14
104+
105+
- Patched `subset_level_by_values` via `clisops 0.9.5`.
106+
107+
## 0.9.0 – 2022-09-27
108+
109+
- Introduced **initial `concat` operator**.
110+
111+
## 0.8.3 – 2022-09-26
112+
113+
- Updated to `clisops 0.9.2`.
114+
- Updated provenance for **C4I**.
115+
116+
## 0.8.2 – 2022-05-16
117+
118+
- Updated to:
119+
- `daops 0.8.1`
120+
- `clisops 0.9.1`
121+
- Added metadata tests.
122+
123+
## 0.8.1 – 2022-04-20
124+
125+
- Updated to `roocs-utils 0.6.1`.
126+
- Fixed `director` for new `average_time` operator.
127+
- Added smoke tests for:
128+
- `c3s-cmip5`
129+
- `c3s-cordex`
130+
131+
## 0.8.0 – 2022-04-14
132+
133+
- Added:
134+
- `average` and `average_time` operators
135+
- Dashboard updates (for Bokeh 2.4.2)
136+
- Removed: `diff` operator
137+
- Updated to:
138+
- `clisops 0.9.0`
139+
- `daops 0.8.0`
140+
- `pywps 4.5.2`
141+
142+
## 0.7.0 – 2021-11-08
143+
144+
- Added `subset-by-point` process.
145+
- Updated:
146+
- `clisops 0.7.0`
147+
- `daops 0.7.0`
148+
- Dashboard and provenance
149+
150+
## 0.6.2 – 2021-08-11
151+
152+
- Updated:
153+
- `pywps 4.4.5`
154+
- Dashboard
155+
- Provenance types and IDs
156+
157+
## 0.6.1 – 2021-06-18
158+
159+
- Added **initial dashboard**.
160+
- Updated to `clisops 0.6.5`.
161+
162+
## 0.6.0 – 2021-05-20
163+
164+
- Moved catalog functionality to `daops`.
165+
- Updated to:
166+
- `roocs-utils 0.4.2`
167+
- `clisops 0.6.4`
168+
- `daops 0.6.0`
169+
- Added initial `usage` process.
170+
171+
## 0.5.0 – 2021-04-01
172+
173+
- Updated:
174+
- `pywps 4.4.2`
175+
- `clisops 0.6.3`
176+
- `roocs-utils 0.3.0`
177+
- Introduced `FileMapper` and intake catalog support.
178+
179+
## 0.4.2 – 2021-03-22
180+
181+
- Updated to `clisops 0.6.2`.
182+
183+
## 0.4.1 – 2021-03-21
184+
185+
- Switched to `pywps 4.4.1` and linked storage.
186+
- Added:
187+
- Storm tests (via Locust)
188+
- Improved smoke tests
189+
- Cleaned requirements and YAML warnings.
190+
- Fixed average output behavior.
191+
192+
## 0.4.0 – 2021-03-04
193+
194+
- Removed unused dependencies.
195+
- Updated to `daops >= 0.5.0`.
196+
- Renamed `axes` input to `dims` in `wps_average`.
197+
- Fixed test data and added smoke tests.
198+
199+
## 0.3.1 – 2021-02-24
200+
201+
- Pinned `cf_xarray < 0.5.0` for compatibility.
202+
203+
## 0.3.0 – 2021-02-24
204+
205+
- Fixed test data using GitPython.
206+
- Updated:
207+
- `pywps 4.4.0`
208+
- Provenance structure
209+
- Subset alignment
210+
- CI (moved to GitHub Actions)
211+
- Added `director` module.
212+
- Improved CMIP6 support.
213+
214+
## 0.2.0 – 2020-11-19
215+
216+
- Built on `cookiecutter` template via `cruft`.
217+
- Processes available: `subset`, `orchestrate`.
218+
- Integrated `daops`, Metalink output, and provenance.
219+
220+
## 0.1.0 – 2020-04-03
221+
222+
- Initial release.

docs/contact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
If you are interested in finding out more about the project please e-mail <{{ site.email }}>.
1+
If you are interested in finding out more about the project please send an [e-mail](mailto:[email protected]).

0 commit comments

Comments
 (0)