-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #768 from DHI/docs_navs
Hybrid navigation
- Loading branch information
Showing
7 changed files
with
147 additions
and
63 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,50 @@ | ||
| --- | ||
| toc: false | ||
| --- | ||
|
|
||
|  | ||
|
|
||
| # MIKE IO: input/output of MIKE files in Python | ||
|  | ||
| [](https://badge.fury.io/py/mikeio) | ||
|
|
||
| Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files. | ||
|
|
||
| See our sister library [MIKE IO 1D](https://github.com/DHI/mikeio1d) for .res1d and .xns11 files. | ||
| ::: {.grid} | ||
|
|
||
| ::: {.g-col-6} | ||
| ## {{< fa clock >}} **Set up in 5 minutes** | ||
|
|
||
| Install **MIKE IO** with [`pip`](https://pypi.org/project/mikeio/) and get up | ||
| and running in minutes | ||
|
|
||
| ## Requirements | ||
|
|
||
| * Windows or Linux operating system | ||
| * Python x64 3.9 - 3.13 | ||
| * (Windows) [VC++ redistributables](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads>) (already installed if you have MIKE) | ||
| [**Getting started**](user-guide/getting-started.qmd) | ||
|
|
||
| ## Installation | ||
| ## {{< fa brands python >}} **It's just Python** | ||
|
|
||
| ``` | ||
| $ pip install mikeio | ||
| ``` | ||
| Read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files. | ||
|
|
||
| [**API Reference**](api/index.qmd) | ||
|
|
||
| ::: callout-warning | ||
| **Don't use conda to install MIKE IO!**, the version on conda is outdated. | ||
| ::: | ||
|
|
||
| ## Getting started | ||
| ::: {.g-col-6} | ||
|
|
||
| ## {{< fa solid diagram-project >}} **Associated package** | ||
|
|
||
| ```{python} | ||
| import mikeio | ||
| See our sister library **MIKE IO 1D** for .res1d and .xns11 files. | ||
|
|
||
| ds = mikeio.read("data/FakeLake.dfsu") | ||
| ds.Bathymetry.plot() | ||
| ``` | ||
| [**MIKE IO 1D**](https://dhi.github.io/mikeio1d/) | ||
|
|
||
| Read more in the [getting started guide](user-guide/getting-started.qmd). | ||
|
|
||
| ## {{< fa scale-balanced >}} **Open Source** | ||
|
|
||
| ## Where can I get help? | ||
| MIKE IO is licensed under BSD-3-Clause license and available on [GitHub](https://github.com/DHI/mikeio) | ||
|
|
||
| [**License**](license.qmd) | ||
|
|
||
| ::: | ||
|
|
||
| ::: | ||
|
|
||
| * New ideas and feature requests - [GitHub Discussions](https://github.com/DHI/mikeio/discussions) | ||
| * Bugs - [GitHub Issues](https://github.com/DHI/mikeio/issues) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| Copyright (c) 2019, DHI A/S | ||
| All rights reserved. | ||
|
|
||
| Redistribution and use in source and binary forms, with or without | ||
| modification, are permitted provided that the following conditions are met: | ||
|
|
||
| * Redistributions of source code must retain the above copyright notice, | ||
| this list of conditions and the following disclaimer. | ||
| * Redistributions in binary form must reproduce the above copyright | ||
| notice, this list of conditions and the following disclaimer in the | ||
| documentation and/or other materials provided with the distribution. | ||
| * Neither the name of DHI nor the names of its contributors may be used to | ||
| endorse or promote products derived from this software without specific | ||
| prior written permission. | ||
|
|
||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
| LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,31 @@ | ||
| from ._dataarray import DataArray | ||
| from ._dataset import Dataset, from_pandas, from_polars | ||
| from ._data_plot import ( | ||
| _DataArrayPlotter, | ||
| _DataArrayPlotterGrid1D, | ||
| _DataArrayPlotterGrid2D, | ||
| _DataArrayPlotterFM, | ||
| _DataArrayPlotterFMVerticalColumn, | ||
| _DataArrayPlotterFMVerticalProfile, | ||
| _DataArrayPlotterPointSpectrum, | ||
| _DataArrayPlotterLineSpectrum, | ||
| _DataArrayPlotterAreaSpectrum, | ||
| _DatasetPlotter, | ||
| ) | ||
|
|
||
| __all__ = ["DataArray", "Dataset", "from_pandas", "from_polars"] | ||
| __all__ = [ | ||
| "DataArray", | ||
| "Dataset", | ||
| "from_pandas", | ||
| "from_polars", | ||
| "_DataArrayPlotter", | ||
| "_DataArrayPlotterGrid1D", | ||
| "_DataArrayPlotterGrid2D", | ||
| "_DataArrayPlotterFM", | ||
| "_DataArrayPlotterFMVerticalColumn", | ||
| "_DataArrayPlotterFMVerticalProfile", | ||
| "_DataArrayPlotterPointSpectrum", | ||
| "_DataArrayPlotterLineSpectrum", | ||
| "_DataArrayPlotterAreaSpectrum", | ||
| "_DatasetPlotter", | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters