Skip to content
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.

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

Small doc updates #38

Merged
merged 3 commits into from
May 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 11 additions & 3 deletions doc/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,25 +51,33 @@ great sources of inspiration for this project.

- xarray_: xarray-simlab actually provides an xarray extension for setting and
running models.
- attrs_: a package that allows writing Python classes without
boilerplate. xarray-simlab uses and extends attrs for writing
processes as succinct Python classes.
- luigi_: the concept of Luigi is to use Python classes as re-usable units that
help building complex workflows. xarray-simlab's concept is similar, but
here it is specific to computational (numerical) modeling.
- django_ (not really a scientific package): the way that model processes are
designed in xarray-simlab is heavily inspired from Django's ORM (i.e., the
``django.db.models`` part).
- django_ (not really a scientific package): the way that model
processes are designed in xarray-simlab has been initially inspired
from Django's ORM (i.e., the ``django.db.models`` part).
- param_: another source of inspiration for the interface of processes
(more specifically the variables that it defines).
- climlab_: another python package for process-oriented modeling, which uses
the same approach although having a slightly different design/API, and which
is applied to climate modeling.
- landlab_: like climlab it provides a framework for building model
components but it is here applied to landscape evolution
modeling. It already has a great list of components ready to use.
- dask_: represents fine-grained processing tasks as Directed Acyclic Graphs
(DAGs). xarray-simlab models are DAGs too, where the nodes are interdepent
processes. In this project we actually borrow some code from dask
for resolving process dependencies and for model visualization.

.. _attrs: https://github.com/python-attrs/attrs
.. _xarray: https://github.com/pydata/xarray
.. _dask: https://github.com/dask/dask
.. _luigi: https://github.com/spotify/luigi
.. _django: https://github.com/django/django
.. _param: https://github.com/ioam/param
.. _climlab: https://github.com/brian-rose/climlab
.. _landlab: https://github.com/landlab/landlab
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@

# General information about the project.
project = 'xarray-simlab'
copyright = '2017, xarray-simlab Developers'
copyright = '2017-2018, xarray-simlab Developers'
author = 'Benoit Bovy and xarray-simlab Developers'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -203,8 +203,8 @@
'python': ('https://docs.python.org/3.6/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'attr': ('http://www.attrs.org/en/stable/', None),
'pandas': ('http://pandas.pydata.org/pandas-docs/stable/', None),
'xarray': ('http://xarray.pydata.org/en/stable/', None)
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
'xarray': ('https://xarray.pydata.org/en/stable/', None)
}


Expand Down