Skip to content
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.

Sign up for GitHub

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

update #72

Merged
merged 4 commits into from
Dec 13, 2024
Merged

update #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9df0458
Merge pull request #68 from MET-OM/dev_ex
KonstantinChri Nov 28, 2024
84d0d11
Merge pull request #69 from MET-OM/dev_ex
KonstantinChri Nov 28, 2024
14b9a03
Update index.rst
KonstantinChri Nov 29, 2024
8e1bba7
Update version.py
KonstantinChri Dec 2, 2024
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
18 changes: 11 additions & 7 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
Welcome to metocean-stats's documentation!
==========================================

**metocean-stats** is a Python package (under development) for metocean analysis of NORA3 (wind and wave) hindcast.
**metocean-stats** is a Python tool for comprehensive statistics and visualization of metocean data (wind, waves, ocean currents, tide levels, air and water temperature, sea ice, and more). The input data is conveniently provided within the tool as a Pandas DataFrame (time series of metocean variables) from a single position.

The package contains functions that:
* generate statistics (tables, diagrams etc)
The tool is designed with cross-platform compatibility in mind. It can smoothly operate on various operating systems, including Linux, Windows, and MacOS. It is also compatible with WEkEO Jupyter Lab, allowing seamless integration and use. For instructions on how to install metocean-stats in WEkEO, please refer `here <https://docs.google.com/document/d/1uEvG_YZ43eu3vE33Qv9t5Bzd0QAmspKjqjzFLHEkJys/edit?usp=sharing>`_

The tool contains functions that generate:
* general (e.g., seasonal, annual) statistics,
* extreme statistics,
* marine operation statistics.

Installing **metocean-stats**
=============================
Expand Down Expand Up @@ -39,9 +43,9 @@ Alternative 2: Using Mambaforge (alternative to Miniconda) and Git
$ conda activate metocean-stats
$ pip install --no-deps -e .

This installs the metocean-stats 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-stats 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:
To update the local conda environment in case new dependencies are added to environment.yml:

.. code-block:: bash

Expand Down Expand Up @@ -83,7 +87,7 @@ Scatter Diagram
.. code-block:: python

tables.scatter_diagram(
ds,
df,
var1='HS',
step_var1=1,
var2='TP',
Expand All @@ -98,7 +102,7 @@ Scatter Diagram
.. code-block:: python

tables.scatter_diagram(
ds,
df,
var1='HS',
step_var1=1,
var2='TP',
Expand Down
2 changes: 1 addition & 1 deletion version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "1.0.4"
__version__ = "1.0.5"


def git_describe():
Expand Down
Loading