|
1 | | -.. scikit-downscale documentation master file, created by |
2 | | - sphinx-quickstart on Wed Oct 9 13:59:33 2019. |
3 | | - You can adapt this file completely to your liking, but it should at least |
4 | | - contain the root `toctree` directive. |
5 | | -
|
6 | 1 | Scikit-downscale: toolkit for statistical downscaling |
7 | 2 | ===================================================== |
8 | 3 |
|
9 | 4 | Scikit-downscale is a toolkit for statistical downscaling using Scikit-Learn_. |
10 | 5 | It is meant to support the development of new and existing downscaling |
11 | 6 | methods in a common framework. It implements Scikit-learn's `fit`/`predict` API |
12 | | -facilitating the development of a wide range of statitical downscaling models. |
| 7 | +facilitating the development of a wide range of statistical downscaling models. |
13 | 8 | Utilities and a high-level API built on Xarray_ and Dask_ support both |
14 | 9 | point-wise and global downscaling applications. |
15 | 10 |
|
16 | 11 | .. _Xarray: http://xarray.pydata.org |
17 | 12 | .. _Scikit-Learn: https://scikit-learn.org |
18 | 13 | .. _Dask: https://dask.org |
19 | 14 |
|
| 15 | +Quick Start |
| 16 | +----------- |
| 17 | + |
| 18 | +Install scikit-downscale: |
| 19 | + |
| 20 | +.. code-block:: bash |
| 21 | +
|
| 22 | + pip install scikit-downscale |
| 23 | +
|
| 24 | +Then try your first downscaling example: |
| 25 | + |
| 26 | +.. code-block:: python |
| 27 | +
|
| 28 | + from skdownscale.pointwise_models import QuantileMapper |
| 29 | +
|
| 30 | + # Initialize the model |
| 31 | + qm = QuantileMapper() |
| 32 | +
|
| 33 | + # Fit on training data |
| 34 | + qm.fit(model_data, observations) |
| 35 | +
|
| 36 | + # Generate downscaled predictions |
| 37 | + downscaled = qm.predict(model_data) |
| 38 | +
|
| 39 | +Ready to learn more? Check out our :doc:`tutorials/getting-started`! |
| 40 | + |
| 41 | +Documentation Structure |
| 42 | +----------------------- |
| 43 | + |
| 44 | +This documentation is organized following the `Diátaxis framework <https://diataxis.fr/>`_: |
| 45 | + |
| 46 | +📚 **Tutorials** - *Learning-oriented* |
| 47 | + Step-by-step lessons to learn scikit-downscale. Start here if you're new! |
| 48 | + |
| 49 | +🔧 **How-to Guides** - *Problem-oriented* |
| 50 | + Practical guides for accomplishing specific tasks. |
| 51 | + |
| 52 | +📖 **Background** - *Understanding-oriented* |
| 53 | + Explanations of concepts, theory, and design decisions. |
| 54 | + |
| 55 | +📋 **Reference** - *Information-oriented* |
| 56 | + Complete API documentation and technical specifications. |
| 57 | + |
| 58 | +.. toctree:: |
| 59 | + :maxdepth: 1 |
| 60 | + :caption: Documentation |
| 61 | + |
| 62 | + tutorials/index |
| 63 | + how-to/index |
| 64 | + background/index |
| 65 | + api |
| 66 | + |
| 67 | +.. toctree:: |
| 68 | + :maxdepth: 1 |
| 69 | + :caption: Project Info |
| 70 | + |
| 71 | + roadmap |
| 72 | + |
20 | 73 | Under Active Development |
21 | 74 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 75 | + |
22 | 76 | Scikit-downscale is under active development. We are looking for additional |
23 | 77 | contributors to help fill out the list of downscaling methods supported here. |
24 | 78 | We are also looking to find collaborators interested in using deep learning |
25 | 79 | to build global downscaling tools. Get in touch with us on our |
26 | | -`GitHub page <https://github.com/jhamman/scikit-downscale>`_. |
27 | | - |
28 | | -.. toctree:: |
29 | | - :maxdepth: 2 |
30 | | - :caption: Contents: |
31 | | - |
32 | | - roadmap |
33 | | - api |
| 80 | +`GitHub page <https://github.com/pangeo-data/scikit-downscale>`_. |
34 | 81 |
|
35 | 82 | Indices and tables |
36 | 83 | ================== |
|
0 commit comments