Skip to content

Commit 67b33e7

Browse files
committed
rrme to user guide and add quicksrat script
1 parent 928a67a commit 67b33e7

File tree

3 files changed

+30
-4
lines changed

3 files changed

+30
-4
lines changed

docs/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ Contents
1717
:maxdepth: 1
1818

1919
self
20-
quickstart
21-
all
20+
auto_examples/plot_quickstart_guide
2221
auto_examples/index
22+
user_guide
23+
all
2324
releases
2425
contributors
2526
contributing

docs/source/quickstart.rst renamed to docs/source/user_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

2-
Quick start guide
3-
=================
2+
User guide
3+
==========
44

55
In the following we provide some pointers about which functions and classes
66
to use for different problems related to optimal transport (OT) and machine

examples/plot_quickstart_guide.py

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# coding: utf-8
2+
"""
3+
=============================================
4+
Quickstart Guide
5+
=============================================
6+
7+
8+
This is a quickstart guide to the Python Optimal Transport (POT) toolbox.
9+
10+
"""
11+
12+
# Author: Remi Flamary
13+
#
14+
# License: MIT License
15+
# sphinx_gallery_thumbnail_number = 1
16+
17+
# %%
18+
# Simple example
19+
# --------------
20+
#
21+
22+
import numpy as np # always need it
23+
import pylab as pl # for the plots
24+
25+
import ot

0 commit comments

Comments
 (0)