Skip to content

Updated vision in docs #210

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
ecomodeller merged 3 commits into from
Jun 19, 2023
Merged

Updated vision in docs #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54e9a0e
Updated vision in docs
ecomodeller Jun 19, 2023
add2719
Remove ModelrResult from API docs
ecomodeller Jun 19, 2023
842f53f
Remove unlisted page
ecomodeller Jun 19, 2023
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
3 changes: 0 additions & 3 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ API Documentation

Model
-----
.. autoclass:: modelskill.model.ModelResult
:members:

.. autoclass:: modelskill.model.PointModelResult
:members:

Expand Down
18 changes: 0 additions & 18 deletions docs/organization.rst
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions docs/vision.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ And it should be

* Difficult to make mistakes by verifying input
* Trustworthy by having >95% test coverage
* Easy to install (from pypi and conda)
* Easy to install (`pip install modelskill`)
* Easy to get started by providing many notebook examples and documentation


Expand All @@ -34,6 +34,7 @@ Scope
`ModelSkill <https://github.com/DHI/modelskill>`_ wants to balance general and specific needs:

* It should be general enough to cover >90% of MIKE FM simulations
* It should be general enough to cover generic modelling irrespective of software.
* But specific enough to be useful
- Support dfs files (using `mikeio <https://github.com/DHI/mikeio>`_)
- Handle circular variables such as wave direction
Expand All @@ -48,9 +49,8 @@ Limitations
`ModelSkill <https://github.com/DHI/modelskill>`_ does **not** wish to cover

* Extreme value analysis
* Forecast skill assessments
* Deterministic wave analysis such as crossing analysis
* Alternative file types
* Rare alternative file types
* Rarely used model result types
* Rare observation types
* Anything project specific
Expand Down