Skip to content

Commit

Permalink
remove unused comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mathleur committed Feb 28, 2024
1 parent 0100a77 commit 85437c3
Showing 1 changed file with 0 additions and 22 deletions.
22 changes: 0 additions & 22 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,39 +33,30 @@ Polytope supports datacubes which have branching, non-uniform indexing, and even
> [!WARNING]
> This project is BETA and will be experimental for the forseable future. Interfaces and functionality are likely to change, and the project itself may be scrapped. DO NOT use this software in any project/software that is operational.
<!-- | :warning: This project is BETA and will be experimental for the foreseeable future. Interfaces and functionality are likely to change. DO NOT use this software in any project/software that is operational. |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -->

## Concept

Polytope is designed to enable extraction of arbitrary extraction of data from a datacube. Instead of the typical range-based bounding-box approach, Polytope can extract any shape of data from a datacube using a "polytope" (*n*-dimensional polygon) stencil.

<!-- <div style="text-align:center"> -->
<p align="center">
<img src="./docs/Overview/images_overview/ecmwf_polytope.png" alt="Polytope Concept" width="450"/>
</p>
<!-- </div> -->

The Polytope algorithm can for example be used to extract:

- 2D cut-outs, such as country cut-outs, from a datacube
<!-- <div style="text-align:center"> -->
<p align="center">
<img src="./docs/images/greece.png" alt="Greece cut-out" width="250"/>
</p>
<!-- </div> -->

- timeseries from a datacube
<p align="center">
<img src="./docs/images/timeseries.png" alt="Timeseries" width="350"/>
</p>
<!-- </div> -->

- more complicated spatio-temporal paths, such as flight paths, from a datacube
<p align="center">
<img src="./docs/images/flight_path.png" alt="Flight path" width="350"/>
</p>
<!-- </div> -->

- and many more high-dimensional shapes in arbitrary dimensions...

Expand Down Expand Up @@ -141,21 +132,8 @@ Here is a step-by-step example of how to use this software.
↳longitude=1.0
```

<!-- # Requirements

Python >= 3.7 (for OrderedDict)
TODO: populate requirements.txt -->

## Testing

<!-- #### Git Large File Storage

Polytope uses Git Large File Storage (LFS) to store large data files used in its tests and examples.
To run the tests and examples, it is thus necessary to install Git LFS, by following instructions provided [here](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) for example.
Once Git LFS is installed, individual data files can be downloaded using the command

git lfs pull --include="*" --exclude="" -->

#### Additional Dependencies

The Polytope tests and examples require additional Python packages compared to the main Polytope algorithm.
Expand Down

0 comments on commit 85437c3

Please sign in to comment.