Skip to content

Commit 8fba344

Browse files
committed
Update index.rst
1 parent 8bf59bd commit 8fba344

File tree

2 files changed

+83
-68
lines changed

2 files changed

+83
-68
lines changed

docs/index.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs/index.rst

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
Welcome to xarray-simlab-ode's documentation!
2+
#############################################
3+
4+
Xarray-simlab-ode provides the `xso` framework for building and solving models based on ordinary differential
5+
equations (ODEs), an extension of `xarray-simlab <https://github.com/xarray-contrib/xarray-simlab>`__.
6+
7+
Xarray-simlab provides a generic framework for building computational models in a modular fashion
8+
and a `xarray <http://xarray.pydata.org/>`__ extension for setting and running simulations using xarray's ``Dataset``
9+
structure.
10+
11+
Xarray-simlab-ode (XSO) extends the Xarray-simlab framework with a set of variables, processes and a solver backend,
12+
suited towards ODE-based models. It is designed for flexible, interactive and reproducible modeling workflows.
13+
14+
.. Note:: This project is in the early stages of development.
15+
16+
Documentation table of contents
17+
===============================
18+
19+
** Getting Started **
20+
21+
* :doc:`about`
22+
* :doc:`install`
23+
24+
.. toctree::
25+
:maxdepth: 1
26+
:hidden:
27+
:caption: Getting Started
28+
29+
about
30+
install
31+
32+
** User Guide **
33+
34+
* :doc:`workflow1_framework`
35+
* :doc:`workflow2_variables_components`
36+
* :doc:`workflow3_models`
37+
38+
.. toctree::
39+
:maxdepth: 1
40+
:hidden:
41+
:caption: User Guide
42+
43+
workflow1_framework
44+
workflow2_variables_components
45+
workflow3_models
46+
47+
48+
** Help & Reference **
49+
* :doc:`api`
50+
* :doc:`contributing`
51+
* :doc:`citation`
52+
* :doc:`changelog`
53+
54+
55+
.. toctree::
56+
:maxdepth: 1
57+
:hidden:
58+
:caption: Help & Reference
59+
60+
api
61+
contributing
62+
citation
63+
changelog
64+
65+
66+
Get involved
67+
============
68+
69+
The package is in the early stages of development. Feedback from testing and contributions are very welcome.
70+
See [GitHub Issues](https://github.com/ben1post/xarray-simlab-ode/issues) for existing issues, or raise your own.
71+
Code contributions can be made via Pull Requests on [GitHub](https://github.com/ben1post/xarray-simlab-ode).
72+
Check out the [contributing guidelines](contributing) for more information.
73+
74+
License
75+
=======
76+
77+
xarray-simlab-ode was created by Benjamin Post.
78+
It is licensed open source under the terms of the BSD 3-Clause license.
79+
80+
Credits
81+
=======
82+
83+
Xarray-simlab-ode is an extension of [xarray-simlab](https://github.com/xarray-contrib/xarray-simlab), created by Benoît Bovy.

0 commit comments

Comments
 (0)