From 018c06200742e2d0c4964db06d7365104ab4dc8c Mon Sep 17 00:00:00 2001 From: Benoit Bovy Date: Mon, 7 May 2018 16:21:54 +0200 Subject: [PATCH 1/3] update doc copyright --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 637986e0..c2aa1207 100755 --- a/doc/conf.py +++ b/doc/conf.py @@ -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 From 036093f933c30fc51cd3bddc19f69166b31984d3 Mon Sep 17 00:00:00 2001 From: Benoit Bovy Date: Mon, 7 May 2018 16:24:47 +0200 Subject: [PATCH 2/3] use https in intersphinx when available --- doc/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index c2aa1207..b59a2b2d 100755 --- a/doc/conf.py +++ b/doc/conf.py @@ -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) } From 502662f2297c276531def38d0cfddc39d84b0c03 Mon Sep 17 00:00:00 2001 From: Benoit Bovy Date: Mon, 7 May 2018 16:38:38 +0200 Subject: [PATCH 3/3] add attrs and landlab to sources of inspiration --- doc/about.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/about.rst b/doc/about.rst index 77c7c9e5..3316e5a2 100644 --- a/doc/about.rst +++ b/doc/about.rst @@ -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