Skip to content

Commit

Permalink
API Docs starting point
Browse files Browse the repository at this point in the history
  • Loading branch information
ecomodeller committed Jan 23, 2025
1 parent 6ebbb1a commit d68c01c
Show file tree
Hide file tree
Showing 4 changed files with 135 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.quarto/
62 changes: 62 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
project:
type: website

website:
title: "MIKE Core"
page-footer: "© 2025 DHI Group"
repo-url: https://github.com/DHI/mikecore-python
repo-actions: [edit]
repo-subdir: docs
page-navigation: true

navbar:
tools:
- icon: github
menu:
- text: Source Code
url: https://github.com/DHI/mikecore-python
- text: Report a Bug
url: https://github.com/DHI/mikecore-python/issues
left:
- href: index.qmd
text: Home
- href: api/index.qmd
text: API Reference

quartodoc:
style: pkgdown
title: API Reference
parser: sphinx
dir: api
package: mikecore
options:
include_inherited: true
include_empty: true
renderer:
style: markdown
display_name: relative

sidebar: "_sidebar.yml"

sections:
- title: Dfs
desc: ""

contents:
- DfsFile.DfsFile
- Dfs123File.Dfs123File
- DfsFactory.DfsFactory
- DfsFileFactory.DfsFileFactory
- title: Mesh
desc: ""
contents:
- MeshBuilder.MeshBuilder
- MeshFile.MeshFile

format:
html:
theme: cosmo
toc: true
ipynb:
theme: cosmo
toc: true
46 changes: 46 additions & 0 deletions docs/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
toc: false
---


# MIKE Core
![](https://badge.fury.io/py/mikecore.svg)


::: {.grid}

::: {.g-col-6}
## **Full flexibility**

Using MIKE Core gives you the ability to build your own Python application using dfs files.


## **It's just Python**

Low level access to read, write and manipulate dfs0, dfs1, dfs2, dfs3, dfsu and mesh files.

[**API Reference**](api/index.qmd)

:::

::: {.g-col-6}

## **Associated packages**

See our higher level libraries **MIKE IO** and **MIKE IO 1D**.

[**MIKE IO**](https://dhi.github.io/mikeio/)
[**MIKE IO 1D**](https://dhi.github.io/mikeio1d/)


## **Open Source**

MIKE Core is licensed under BSD-3-Clause license and available on [GitHub](https://github.com/DHI/mikecore-python)

[**License**](license.qmd)

:::

:::


26 changes: 26 additions & 0 deletions docs/license.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Copyright (c) 2019,
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.

0 comments on commit d68c01c

Please sign in to comment.