Skip to content

Cleanup docs #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jun 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 7 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,20 @@ Contributions are welcome. Feel free to open a pull request with changes.

## Running it Locally

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:
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:

- Make sure you have ruby installed on your computer. See https://www.ruby-lang.org/en/downloads/
- `bundle install`
- `bundle exec jekyll serve`
- Point your browser at http://127.0.0.1:4000/
````
conda env create

### Use Docker as build environment
conda activate roocs

Run this once to generate Gemfile.lock:
```
docker-compose run jekyll bundle install
```
mkdocs build

Build image:
```
docker-compose build
```
mkdocs serve

Start service:
```
docker-compose up
Open browser: http://127.0.0.1:8000
```

Open http://localhost:4000

## Deployment

Pull requests merged to the main branch are automatically deployed to the production website.
Expand Down
41 changes: 26 additions & 15 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,33 @@
# What is the project about?
# 🧊 About the Project

We provide *data-aware* processing services of climate projections (like CMIP6 global data)
for the [Climate Data Store](https://cds.climate.copernicus.eu) (CDS).
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/).

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

* [IPSL](https://www.ipsl.fr/en)
* [DKRZ](https://www.dkrz.de/)
---

## Which projects and groups do we work with?
## 👥 Who’s Involved?

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

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

Led by [STFC/CEDA](http://www.ceda.ac.uk/) and [DKRZ](https://www.dkrz.de/) further development on roocs
happens to make the roocs processing services available for [ESGF](https://esgf.llnl.gov/).
---

## 🤝 Collaborating Organizations

We actively work with several partners and community groups:

- 🛰️ [STFC/CEDA](http://www.ceda.ac.uk/)
- 🌍 [ESGF](https://esgf.llnl.gov/)
- 🌦️ [Ouranos](https://github.com/Ouranosinc)
- 🧠 [CRIM](https://github.com/crim-ca)
- 🐍 [GeoPython](https://github.com/geopython)

---

## 🚀 Future Development

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.
222 changes: 222 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
# Changelog

## 0.17.2 – 2025-05-08

- Updated tests for **Atlas v2**.
- Fixed dashboard for latest `bokeh >= 3.7`.

## 0.17.1 – 2025-05-06

- Fixed calendar bug for **proleptic Gregorian** calendar.

## 0.17.0 – 2025-04-29

- Added support for **Atlas v2** data.

## 0.16.1 – 2025-02-26

- Fixed smoke tests.
- Added `beautifulsoup` to requirements.

## 0.16.0 – 2025-02-21

- Switched to **pooch** for test data management.
- Modernized Python code and deployment.
- Removed `roocs-utils`. Now requires:
- `clisops >= 0.15.0`
- `daops >= 0.14.0`
- Replaced linting setup with **ruff**.
- Changed default Git branch to `main`.

## 0.15.0 – 2024-11-20

- Improved decadal fixes for **proleptic Gregorian** calendar.
- Provenance now includes local installation "site" name.
- Fixed documentation links.

## 0.14.0 – 2024-10-22

- Added Docker image test step to CI.
- Updated CI workflows and template:
- New `CODE_OF_CONDUCT.rst`
- Modernized Dockerfile
- Documented all processes
- Switched to `pyproject.toml` with `flit-core`
- Adopted `src/` layout

## 0.13.1 – 2024-07-22

- Added process: **average over polygon**.
- Updated **CDS domain**.

## 0.13.0 – 2024-02-06

- Added **subsetting support for Atlas v1** datasets.

## 0.12.2 – 2023-12-08

- Fixed `time_components` for **360-day calendar** compatibility.

## 0.12.1 – 2023-12-04

- Patched fill-value issue via updated `clisops`.
- Added smoke test for fill-value handling.

## 0.12.0 – 2023-11-28

- Added **regridding operator** from `clisops`.
- Added tests and smoke tests for regridding.
- CI now uses Conda.

## 0.11.0 – 2023-11-09

- Added **weighted average** operator and WPS process.
- Added WPS regridding process (dummy operator).
- Updated to:
- `pywps 4.6.0`
- `clisops` and `daops` with decadal fixes
- Dropped Python 3.8 support.

## 0.10.1 – 2023-07-20

- Updated fix application logic.
- Fixed smoke tests for CMIP5.

## 0.10.0 – 2023-07-12

- Updated `concat` operator to optionally apply subsetting and averaging.
- Applied CMIP6 decadal fixes directly (no ElasticSearch lookup).
- Updated to `clisops 0.10.0`.

## 0.9.3 – 2023-05-16

- Added smoke tests for:
- `c3s-ipcc-atlas`
- `c3s-cmip6-decadal`
- Updated `roocs` config for `c3s-ipcc-atlas`.

## 0.9.2 – 2023-02-02

- Updated to `roocs-utils` with `realization` dimension support.
- Updated `concat` operator.

## 0.9.1 – 2022-12-14

- Patched `subset_level_by_values` via `clisops 0.9.5`.

## 0.9.0 – 2022-09-27

- Introduced **initial `concat` operator**.

## 0.8.3 – 2022-09-26

- Updated to `clisops 0.9.2`.
- Updated provenance for **C4I**.

## 0.8.2 – 2022-05-16

- Updated to:
- `daops 0.8.1`
- `clisops 0.9.1`
- Added metadata tests.

## 0.8.1 – 2022-04-20

- Updated to `roocs-utils 0.6.1`.
- Fixed `director` for new `average_time` operator.
- Added smoke tests for:
- `c3s-cmip5`
- `c3s-cordex`

## 0.8.0 – 2022-04-14

- Added:
- `average` and `average_time` operators
- Dashboard updates (for Bokeh 2.4.2)
- Removed: `diff` operator
- Updated to:
- `clisops 0.9.0`
- `daops 0.8.0`
- `pywps 4.5.2`

## 0.7.0 – 2021-11-08

- Added `subset-by-point` process.
- Updated:
- `clisops 0.7.0`
- `daops 0.7.0`
- Dashboard and provenance

## 0.6.2 – 2021-08-11

- Updated:
- `pywps 4.4.5`
- Dashboard
- Provenance types and IDs

## 0.6.1 – 2021-06-18

- Added **initial dashboard**.
- Updated to `clisops 0.6.5`.

## 0.6.0 – 2021-05-20

- Moved catalog functionality to `daops`.
- Updated to:
- `roocs-utils 0.4.2`
- `clisops 0.6.4`
- `daops 0.6.0`
- Added initial `usage` process.

## 0.5.0 – 2021-04-01

- Updated:
- `pywps 4.4.2`
- `clisops 0.6.3`
- `roocs-utils 0.3.0`
- Introduced `FileMapper` and intake catalog support.

## 0.4.2 – 2021-03-22

- Updated to `clisops 0.6.2`.

## 0.4.1 – 2021-03-21

- Switched to `pywps 4.4.1` and linked storage.
- Added:
- Storm tests (via Locust)
- Improved smoke tests
- Cleaned requirements and YAML warnings.
- Fixed average output behavior.

## 0.4.0 – 2021-03-04

- Removed unused dependencies.
- Updated to `daops >= 0.5.0`.
- Renamed `axes` input to `dims` in `wps_average`.
- Fixed test data and added smoke tests.

## 0.3.1 – 2021-02-24

- Pinned `cf_xarray < 0.5.0` for compatibility.

## 0.3.0 – 2021-02-24

- Fixed test data using GitPython.
- Updated:
- `pywps 4.4.0`
- Provenance structure
- Subset alignment
- CI (moved to GitHub Actions)
- Added `director` module.
- Improved CMIP6 support.

## 0.2.0 – 2020-11-19

- Built on `cookiecutter` template via `cruft`.
- Processes available: `subset`, `orchestrate`.
- Integrated `daops`, Metalink output, and provenance.

## 0.1.0 – 2020-04-03

- Initial release.
2 changes: 1 addition & 1 deletion docs/contact.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If you are interested in finding out more about the project please e-mail <{{ site.email }}>.
If you are interested in finding out more about the project please send an [e-mail](mailto:[email protected]).
Loading