Vous avez reçu un message "Your GitLab account has been locked ..." ? Pas d'inquiétude : lisez cet article https://docs.gricad-pages.univ-grenoble-alpes.fr/help/unlock/

Commit 3d53083b authored by Jerome Touvier's avatar Jerome Touvier
Browse files

doc update

parent 479a17dd
Pipeline #68013 passed with stage
in 57 seconds
......@@ -29,7 +29,7 @@ def humanize_size(size_in_bytes):
def is_like_or_equal(params, key):
""" Builds the condition for the specified key in the "where" clause taking into account lists or wildcards. """
"""Builds the condition for the specified key in the "where" clause taking into account lists or wildcards."""
subquery = list()
for param in params[key].split(","):
......@@ -138,7 +138,7 @@ def timeseries_sql_request(params):
def sql_request(params):
""" Builds the PostgreSQL request """
"""Builds the PostgreSQL request"""
if params["request"] == "country":
s = country_sql_request(params)
......@@ -154,7 +154,7 @@ def sql_request(params):
def collect_data(params):
""" Get the result of the SQL query. """
"""Get the result of the SQL query."""
logging.debug("Start collecting data...")
with psycopg2.connect(current_app.config["DATABASE_URI"]) as conn:
......@@ -197,7 +197,7 @@ def get_header(params):
def get_column_widths(data, header=None):
""" Find the maximum width of each column"""
"""Find the maximum width of each column"""
ncols = range(len(data[0]))
colwidths = [max([len(r[i]) for r in data]) for i in ncols]
if header:
......@@ -222,7 +222,7 @@ def records_to_text(params, data, sep=" "):
def records_to_json(params, data):
""" Create json output """
"""Create json output"""
header = [h.lower() for h in get_header(params)]
dictlist = [dict(zip(header, row)) for row in data]
......
......@@ -5,22 +5,21 @@ This service provides access to the RESIF-DC statistics.
## Query usage
/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options]
/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options] [nodata=404]
where :
request-options :: (request=<country|map|send|storage|timeseries>)
channel-options :: [net=<network> & sta=<station> & loc=<location> & cha=<channel>]
date-options :: [starttime=<date>] & [endtime=<date>]
storage-options :: [year=<year>] & [type=<buffer|validated>]
send-options :: [ranklimit=<number>] & [sum=<boolean>]
other-options :: [country=<country_code>] & [media=<dataselect|seedlink|station>]
channel-options :: [net=<network> sta=<station> loc=<location> cha=<channel>]
date-options :: [starttime=<date>] [endtime=<date>]
storage-options :: [year=<year>] [type=<buffer|validated>]
send-options :: [ranklimit=<number>] [sum=<boolean>]
other-options :: [country=<country_code>] [media=<dataselect|seedlink|station>]
output-options :: [format=<csv|json|text>]
(..) required
[..] optional
## Sample queries
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=storage&net=FR&year=2020">http://ws.resif.fr/resifws/statistics/1/query?request=storage&net=FR&year=2020</a>\
......@@ -56,12 +55,12 @@ The 'time' field represents the first day of a period of one week.
## Detailed descriptions of each query parameter
| Parameter | Example | Discussion |
| :--------- | :------- | :----------------------------------------------------------------------------- |
| net[work] | FR Z32015 | Seismic network name. |
| sta[tion] | CIEL | Station name. |
| loc[ation] | 00 | Location code. Use loc=-- for empty location codes. This parameter accepts wildcards. |
| cha[nnel] | HHZ | Channel Code. This parameter accepts wildcards. |
| Parameter | Example | Discussion |
| :--------- | :------- | :--------------------------------------------------------------------------------|
| net[work] | FR | Seismic network name. Accepts wildcards and lists. |
| sta[tion] | CIEL | Station name. Accepts wildcards and lists. |
| loc[ation] | 00 | Location code. Use loc=-- for empty location codes. Accepts wildcards and lists. |
| cha[nnel] | HHZ | Channel Code. Accepts wildcards and lists. | |
| start[time] | 2010-01-10T00:00:00 | Specify the responses that cover the time period after (and including) this time. |
| end[time] | 2011-02-11T01:00:00 | Specify responses that cover the time period prior to this time. |
| format | text | The output format. Accepted values are text (the default), json, and csv. |
......@@ -85,13 +84,6 @@ The 'time' field represents the first day of a period of one week.
| country | FR,GB | Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2). The value __all__ returns the sum on all country. |
| media | seedlink | Protocol used to request data. Allowed values : __dataselect__, __seedlink__, and __station__ (all by default) |
## Station code details
- network = one to two alphanumeric characters or extented sismic network
- station = one to five alphanumeric characters
- location = two alphanumeric characters
- channel = three alphanumeric characters
## Date and time formats
YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123
......
......@@ -5,22 +5,21 @@ Ce service donne accès aux statistiques de RESIF-DC.
## Utilisation de la requête
/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options]
/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options] [nodata=404]
où :
request-options :: (request=<country|map|send|storage|timeseries>)
channel-options :: [net=<network> & sta=<station> & loc=<location> & cha=<channel>]
date-options :: [starttime=<date>] & [endtime=<date>]
storage-options :: [year=<year>] & [type=<buffer|validated>]
send-options :: [ranklimit=<number>] & [sum=<boolean>]
other-options :: [country=<country_code>] & [media=<dataselect|seedlink|station>]
channel-options :: [net=<network> sta=<station> loc=<location> cha=<channel>]
date-options :: [starttime=<date>] [endtime=<date>]
storage-options :: [year=<year>] [type=<buffer|validated>]
send-options :: [ranklimit=<number>] [sum=<boolean>]
other-options :: [country=<country_code>] [media=<dataselect|seedlink|station>]
output-options :: [format=<csv|json|text>]
(..) requis
[..] optionnel
## Exemples de requêtes
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=storage&net=FR&year=2020">http://ws.resif.fr/resifws/statistics/1/query?request=storage&net=FR&year=2020</a>\
......@@ -44,7 +43,6 @@ Ce service donne accès aux statistiques de RESIF-DC.
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect</a>
### Exemple de sortie avec la requête timeseries
time country bytes clients\
......@@ -57,12 +55,12 @@ La colonne 'time' représente le premier jour d'une période d'une semaine.
## Descriptions détaillées de chaque paramètre de la requête
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :------------------------------------------------------------------------------ |
| net[work] | FR Z32015 | Nom du réseau sismique. |
| sta[tion] | CIEL | Nom de la station. |
| loc[ation] | 00 | Code de localisation. Utilisez loc=-- pour des codes de localisations vides. Ce paramètre accepte les jokers. |
| cha[nnel] | HHZ | Code de canal. Ce paramètre accepte les jokers. |
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :---------------------------------------------------------------------------- |
| net[work] | FR | Nom du réseau sismique. Accepte les jokers et les listes. |
| sta[tion] | CIEL | Nom de la station. Accepte les jokers et les listes. |
| loc[ation] | 00 | Code de localisation. Utilisez loc=-- pour les codes de localisations vides. Accepte les jokers et les listes. |
| cha[nnel] | HHZ | Code de canal. Accepte les jokers et les listes. |
| start[time] | 2010-01-10T00:00:00 | Donne les réponses qui couvrent la période après la date donnée incluse. |
| end[time] | 2011-02-11T01:00:00 | Donne les réponses qui couvrent la période avant la date donnée incluse. |
| format | text | Format de sortie. Valeurs autorisées : text, json et csv. |
......@@ -86,13 +84,6 @@ La colonne 'time' représente le premier jour d'une période d'une semaine.
| country | FR,GB | Filtre les réponses avec une liste des pays d'origine. Utilisez l'abréviation en deux lettres du pays (ISO 3166-1 alpha-2). La valeur __all__ donne la somme sur tous les pays. |
| media | seedlink | Protocoles utilisés pour la requête. Valeurs autorisées : __dataselect__, __seedlink__ et __station__ (toutes par défaut)|
## Détails sur la nomenclature des codes
- NETWORK : 1 à 2 caractères alphanumériques ou le nom du réseau étendu. Un groupe de points de mesures.
- STATION : 1 à 5 caractères alphanumériques. Un site de mesure dans un réseau.
- CHANNEL : 3 caractères alphanumériques. Le premier caractère indique la bande de fréquence du capteur, le second le type de l'instrument et le troisième l'orientation physique.
- LOCATION : 2 caractères alphanumériques. Ils permettent de distinguer plusieurs flux de données d'un même canal.
## Formats des dates et des heures
YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123
......
......@@ -20,6 +20,8 @@ perl -i -0pe 's/<\/head>/<link rel="stylesheet" href=".\/static\/resifws.css"\/>
fi
mv $FILE ../templates/
# perl -i -0pe
# -i in-place
# -0 read entire file in one shot (without the multiline searches failed).
......
......@@ -8,90 +8,71 @@ body {
color: black;
font-family: Verdana, sans-serif;
font-size: 90%;
line-height: 140%;
color: #333;
line-height: 120%;
}
a {
font-family: Verdana, sans-serif;
font-size: 80%;
text-decoration: none;
font-family: Verdana, sans-serif;
font-size: 80%;
text-decoration: none;
}
th {
white-space: nowrap;
border-bottom: 1px solid #ddd;
background-color:#9ca8df;
font-weight: normal;
color: white;
background-color:#3877d1;
}
th, td {
padding: 5px;
padding: 3px;
text-align: left;
font-size: 90%;
}
tr:nth-child(even) {background-color: #f2f2f2;}
tr:nth-child(even) {
background-color: #f2f2f2;
}
pre {
border: 1px dotted gray;
background-color: #ececec;
color: #1111111;
padding: 0.5em;
}
code {
font-family: monospace;
}
h1 a, h2 a, h3 a, h4 a, h5 a {
text-decoration: none;
color: #7a5ada;
h1, h2, h3, h4, h5 {
font-family: verdana;
font-weight: bold;
color: #222;
}
h1, h2, h3, h4, h5 { font-family: verdana;
font-weight: bold;
border-bottom: 1px dotted black;
color: #483583; }
/* color: #7c0f0f; }*/
h1 {
font-size: 130%;
font-weight: normal;
color: #622;
border-bottom: 1px dotted #622;
}
h2 {
font-size: 110%;
font-weight: normal;
color: #622;
border-bottom: 1px dotted #622;
}
h3 {
font-size: 95%;
font-size: 100%;
}
h4 {
font-size: 90%;
font-style: italic;
font-size: 90%;
font-style: italic;
}
h5 {
font-size: 90%;
font-style: italic;
font-size: 80%;
font-style: italic;
}
h1.title {
font-size: 200%;
font-weight: bold;
padding-top: 0.2em;
padding-bottom: 0.2em;
text-align: left;
border: none;
}
dt code {
font-weight: bold;
}
dd p {
margin-top: 0;
}
#footer {
padding-top: 1em;
font-size: 70%;
color: gray;
text-align: center;
}
......@@ -21,16 +21,16 @@
<h1 id="webservice-statistics">Webservice statistics</h1>
<p>Ce service donne accès aux statistiques de RESIF-DC.</p>
<h2 id="utilisation-de-la-requête">Utilisation de la requête</h2>
<pre><code>/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options]
<pre><code>/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options] [nodata=404]
où :
request-options :: (request=&lt;country|map|send|storage|timeseries&gt;)
channel-options :: [net=&lt;network&gt; &amp; sta=&lt;station&gt; &amp; loc=&lt;location&gt; &amp; cha=&lt;channel&gt;]
date-options :: [starttime=&lt;date&gt;] &amp; [endtime=&lt;date&gt;]
storage-options :: [year=&lt;year&gt;] &amp; [type=&lt;buffer|validated&gt;]
send-options :: [ranklimit=&lt;number&gt;] &amp; [sum=&lt;boolean&gt;]
other-options :: [country=&lt;country_code&gt;] &amp; [media=&lt;dataselect|seedlink|station&gt;]
channel-options :: [net=&lt;network&gt; sta=&lt;station&gt; loc=&lt;location&gt; cha=&lt;channel&gt;]
date-options :: [starttime=&lt;date&gt;] [endtime=&lt;date&gt;]
storage-options :: [year=&lt;year&gt;] [type=&lt;buffer|validated&gt;]
send-options :: [ranklimit=&lt;number&gt;] [sum=&lt;boolean&gt;]
other-options :: [country=&lt;country_code&gt;] [media=&lt;dataselect|seedlink|station&gt;]
output-options :: [format=&lt;csv|json|text&gt;]
(..) requis
......@@ -62,7 +62,7 @@ output-options :: [format=&lt;csv|json|text&gt;]
<colgroup>
<col style="width: 10%" />
<col style="width: 7%" />
<col style="width: 82%" />
<col style="width: 81%" />
</colgroup>
<thead>
<tr class="header">
......@@ -74,23 +74,23 @@ output-options :: [format=&lt;csv|json|text&gt;]
<tbody>
<tr class="odd">
<td style="text-align: left;">net[work]</td>
<td style="text-align: left;">FR Z32015</td>
<td style="text-align: left;">Nom du réseau sismique.</td>
<td style="text-align: left;">FR</td>
<td style="text-align: left;">Nom du réseau sismique. Accepte les jokers et les listes.</td>
</tr>
<tr class="even">
<td style="text-align: left;">sta[tion]</td>
<td style="text-align: left;">CIEL</td>
<td style="text-align: left;">Nom de la station.</td>
<td style="text-align: left;">Nom de la station. Accepte les jokers et les listes.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">loc[ation]</td>
<td style="text-align: left;">00</td>
<td style="text-align: left;">Code de localisation. Utilisez loc=-- pour des codes de localisations vides. Ce paramètre accepte les jokers.</td>
<td style="text-align: left;">Code de localisation. Utilisez loc=-- pour les codes de localisations vides. Accepte les jokers et les listes.</td>
</tr>
<tr class="even">
<td style="text-align: left;">cha[nnel]</td>
<td style="text-align: left;">HHZ</td>
<td style="text-align: left;">Code de canal. Ce paramètre accepte les jokers.</td>
<td style="text-align: left;">Code de canal. Accepte les jokers et les listes.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">start[time]</td>
......@@ -195,13 +195,6 @@ output-options :: [format=&lt;csv|json|text&gt;]
</tr>
</tbody>
</table>
<h2 id="détails-sur-la-nomenclature-des-codes">Détails sur la nomenclature des codes</h2>
<ul>
<li>NETWORK : 1 à 2 caractères alphanumériques ou le nom du réseau étendu. Un groupe de points de mesures.</li>
<li>STATION : 1 à 5 caractères alphanumériques. Un site de mesure dans un réseau.</li>
<li>CHANNEL : 3 caractères alphanumériques. Le premier caractère indique la bande de fréquence du capteur, le second le type de l’instrument et le troisième l’orientation physique.</li>
<li>LOCATION : 2 caractères alphanumériques. Ils permettent de distinguer plusieurs flux de données d’un même canal.</li>
</ul>
<h2 id="formats-des-dates-et-des-heures">Formats des dates et des heures</h2>
<pre><code>YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123
YYYY-MM-DD ex. 1997-01-31 (une heure de 00:00:00 est supposée)
......
......@@ -21,16 +21,16 @@
<h1 id="webservice-statistics">Webservice statistics</h1>
<p>This service provides access to the RESIF-DC statistics.</p>
<h2 id="query-usage">Query usage</h2>
<pre><code>/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options]
<pre><code>/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options] [nodata=404]
where :
request-options :: (request=&lt;country|map|send|storage|timeseries&gt;)
channel-options :: [net=&lt;network&gt; &amp; sta=&lt;station&gt; &amp; loc=&lt;location&gt; &amp; cha=&lt;channel&gt;]
date-options :: [starttime=&lt;date&gt;] &amp; [endtime=&lt;date&gt;]
storage-options :: [year=&lt;year&gt;] &amp; [type=&lt;buffer|validated&gt;]
send-options :: [ranklimit=&lt;number&gt;] &amp; [sum=&lt;boolean&gt;]
other-options :: [country=&lt;country_code&gt;] &amp; [media=&lt;dataselect|seedlink|station&gt;]
channel-options :: [net=&lt;network&gt; sta=&lt;station&gt; loc=&lt;location&gt; cha=&lt;channel&gt;]
date-options :: [starttime=&lt;date&gt;] [endtime=&lt;date&gt;]
storage-options :: [year=&lt;year&gt;] [type=&lt;buffer|validated&gt;]
send-options :: [ranklimit=&lt;number&gt;] [sum=&lt;boolean&gt;]
other-options :: [country=&lt;country_code&gt;] [media=&lt;dataselect|seedlink|station&gt;]
output-options :: [format=&lt;csv|json|text&gt;]
(..) required
......@@ -74,23 +74,23 @@ output-options :: [format=&lt;csv|json|text&gt;]
<tbody>
<tr class="odd">
<td style="text-align: left;">net[work]</td>
<td style="text-align: left;">FR Z32015</td>
<td style="text-align: left;">Seismic network name.</td>
<td style="text-align: left;">FR</td>
<td style="text-align: left;">Seismic network name. Accepts wildcards and lists.</td>
</tr>
<tr class="even">
<td style="text-align: left;">sta[tion]</td>
<td style="text-align: left;">CIEL</td>
<td style="text-align: left;">Station name.</td>
<td style="text-align: left;">Station name. Accepts wildcards and lists.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">loc[ation]</td>
<td style="text-align: left;">00</td>
<td style="text-align: left;">Location code. Use loc=-- for empty location codes. This parameter accepts wildcards.</td>
<td style="text-align: left;">Location code. Use loc=-- for empty location codes. Accepts wildcards and lists.</td>
</tr>
<tr class="even">
<td style="text-align: left;">cha[nnel]</td>
<td style="text-align: left;">HHZ</td>
<td style="text-align: left;">Channel Code. This parameter accepts wildcards.</td>
<td style="text-align: left;">Channel Code. Accepts wildcards and lists.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">start[time]</td>
......@@ -190,13 +190,6 @@ output-options :: [format=&lt;csv|json|text&gt;]
</tr>
</tbody>
</table>
<h2 id="station-code-details">Station code details</h2>
<ul>
<li>network = one to two alphanumeric characters or extented sismic network</li>
<li>station = one to five alphanumeric characters</li>
<li>location = two alphanumeric characters</li>
<li>channel = three alphanumeric characters</li>
</ul>
<h2 id="date-and-time-formats">Date and time formats</h2>
<pre><code>YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123
YYYY-MM-DD ex. 1997-01-31 (a time of 00:00:00 is assumed)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment