Skip to content
This repository was archived by the owner on Jun 18, 2023. It is now read-only.

Commit 88557ad

Browse files
committed
Link to bench; update docs
1 parent c62f8fb commit 88557ad

20 files changed

+153
-4
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Build Status](https://travis-ci.org/ceholden/yatsm.svg)](https://travis-ci.org/ceholden/yatsm)
44
[![Coverage Status](https://coveralls.io/repos/ceholden/yatsm/badge.svg?branch=master&service=github)](https://coveralls.io/github/ceholden/yatsm?branch=master&q=q)
55
[![DOI](https://zenodo.org/badge/6804/ceholden/yatsm.svg)](https://zenodo.org/badge/latestdoi/6804/ceholden/yatsm) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ceholden/yatsm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
6+
[![asv](http://img.shields.io/badge/benchmarked%20by-asv-green.svg?style=flat)](http://ceholden.github.io/yatsm/bench/)
67

78
## About
89
Yet Another Timeseries Model (YATSM) is a Python package for utilizing a collection of timeseries algorithms and methods designed to monitor the land surface using remotely sensed imagery.

docs/build_docs.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@ sphinx-apidoc -f -e -o docs/yatsm yatsm/
1313
cd docs/
1414

1515
make html
16+
17+
# copy benchmarks
18+
cd $(dirname $0)/../bench/
19+
asv publish
20+
cp -R html ../docs/_build/html/bench

docs/yatsm/yatsm.accel.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
yatsm.accel module
2+
==================
3+
4+
.. automodule:: yatsm.accel
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/yatsm/yatsm.cli.console.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
yatsm.cli.console module
2+
========================
3+
4+
.. automodule:: yatsm.cli.console
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/yatsm/yatsm.cli.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Submodules
99
yatsm.cli.cache
1010
yatsm.cli.changemap
1111
yatsm.cli.classify
12+
yatsm.cli.console
1213
yatsm.cli.line
1314
yatsm.cli.main
1415
yatsm.cli.map

docs/yatsm/yatsm.mapping.changes.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
yatsm.mapping.changes module
2+
============================
3+
4+
.. automodule:: yatsm.mapping.changes
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
yatsm.mapping.classification module
2+
===================================
3+
4+
.. automodule:: yatsm.mapping.classification
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
yatsm.mapping.phenology module
2+
==============================
3+
4+
.. automodule:: yatsm.mapping.phenology
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
yatsm.mapping.prediction module
2+
===============================
3+
4+
.. automodule:: yatsm.mapping.prediction
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/yatsm/yatsm.mapping.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
yatsm.mapping package
2+
=====================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
9+
yatsm.mapping.changes
10+
yatsm.mapping.classification
11+
yatsm.mapping.phenology
12+
yatsm.mapping.prediction
13+
yatsm.mapping.utils
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: yatsm.mapping
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

0 commit comments

Comments
 (0)