Skip to content

Commit

Permalink
Update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
KonstantinChri authored Nov 28, 2024
1 parent 3e2a47f commit 85ec09f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
Welcome to metocean-api's documentation!
=====================================

**metocean-api** is a Python tool designed to extract time series of metocean (meteorological and oceanographic) data from a variety of sources, including global, regional, and coastal hindcasts and reanalysis.
**metocean-api** is a Python tool designed to extract time series of metocean (meteorological and oceanographic) data from various sources, including global, regional, and coastal hindcasts and reanalysis.
The extracted data can be saved in CSV format or NetCDF for further analysis and usage.
Refer to the section below for more information about the available datasets and variables.
Please look at the section below for more information about the available datasets and variables.

Installing **metocean-api**
=============================================
Expand Down Expand Up @@ -53,7 +53,7 @@ Alternative 2: Using Mambaforge (alternative to Miniconda) and Git
$ conda activate metocean-api
$ pip install --no-deps -e .
This installs the metocean-api as an editable package. Therefore, you can directly make changes to the repository or fetch the newest changes with :code:`git pull`.
This installs the metocean-api as an editable package. Therefore, you can directly change the repository or fetch the newest changes with :code:`git pull`.

To update the local conda environment in case of new dependencies added to environment.yml:

Expand All @@ -78,6 +78,8 @@ Available Datasets in metocean-api

Several options for **product** are available. Please check the data catalog for the time coverage:

:warning: Parallel downloading should be avoided for NORA3 data.

* For wind NORA3 hourly data in 10, 20, 50, 100, 250, 500, 750m (Nordic Area) developed by MET Norway:

.. code-block:: python
Expand Down

0 comments on commit 85ec09f

Please sign in to comment.