Skip to content

ModelResult - docs #176

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

Merged
jsmariegaard merged 1 commit into from
Mar 28, 2023
Merged

ModelResult - docs #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 2 additions & 13 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,12 @@ result file path and a name:
.. code-block:: python

from fmskill import ModelResult
mr = ModelResult("HKZN_local_2017.dfsu", name="HKZN_local")
mr = ModelResult("HKZN_local_2017.dfsu", name="HKZN_local", item="Sign. Wave Heigt")

Currently, ModelResult supports .dfs0 and .dfsu files and pandas DataFrame.
Only the file header is read when the ModelResult object is created.
The data will be read later.

The ModelResult can be constructed without specifying a specific item as shown here.
But the the item must be specified later (e.g. when connecting to an observation)
by mr[0] or similar.



2. Define Observations
Expand Down Expand Up @@ -78,14 +74,7 @@ The observations are connected with a model result using the
.. code-block:: python

from fmskill import Connector
con = Connector([HKNA, c2], mr[0])

Note
----
Only ModelResults with a single item can be added to the Connector.
From a multi-item ModelResult 'mr' an item must selected e.g. with
'mr[0]' before adding.

con = Connector([HKNA, c2], mr)


4. Extract ModelResults at observation positions
Expand Down