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 95b1b521 authored by Jerome Touvier's avatar Jerome Touvier
Browse files

Merge branch 'doc' into 'master'

update doc

See merge request !8
parents 18c37703 a218be77
Pipeline #47290 passed with stage
in 51 seconds
......@@ -39,7 +39,20 @@ This service provides access to the RESIF-DC statistics.
| cha[nnel] | HHZ | Channel Code. This parameter accepts wildcards. |
| 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 | json | Specify output format. Accepted values are text (the default) and csv. |
| format | json | The output format. Accepted values are text (the default) and csv. |
| request | send | Type of statistic requested. Allowed values : <br> - __country__ : the number of requests from each country <br> - __send__ : the volume of distributed data by protocol <br> - __storage__ : the volume of data stored <br> - __timeseries__ : returns a timeseries with the country, the number and the volume of requests |
### Additional parameters for country, send, and timeseries request options
| Parameter | Example | Discussion |
| :--------- | :------- | :------------------------------------------------------------------------------ |
| country | FR,GB | Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2). |
| media | seedlink | Protocol used to request data. Allowed values : all (the default), dataselect, and seedlink |
### Additional parameters for storage request option
| Parameter | Example | Discussion |
| :--------- | :------- | :------------------------------------------------------------------------------ |
| type | validated | Type of data. Allowed values : all (the default), bud, and validated |
| years | 2019,2020 | List of years for which the volume of data is requested. |
## Station code details
......
......@@ -38,20 +38,20 @@ Ce service donne accès aux statistiques de RESIF-DC.
| cha[nnel] | HHZ | Code de canal. Ce paramètre accepte les jokers. |
| 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 | txt | Format de sortie. Valeurs autorisées : text et csv. |
| format | txt | Format de sortie. Valeurs autorisées : text et csv. |
| request | send | Type de la statistique demandée. Valeurs autorisées : <br> - __country__ : nombre de requêtes passées par pays <br> - __send__ : volume de données distribuées par protocoles <br> - __storage__ : quantité de données stockées brutes et validées <br> - __timeseries__ : produit une série temporelle avec en colonne le pays, le nombre et la taille cumulés des requêtes |
### Options supplémentaires spécifiques aux requêtes country, send, et timeseries
### Options supplémentaires spécifiques aux requêtes country, send et timeseries
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :------------------------------------------------------------------------------ |
| country | FR,GB | Filtre les réponses avec une liste des pays d'origine. La valeur est l'abréviation en deux lettres du pays. |
| 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). |
| media | seedlink | Protocoles utilisés pour la requête. Valeurs autorisées : all (par défaut), dataselect et seedlink |
### Options supplémentaires spécifiques à la requête storage
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :------------------------------------------------------------------------------ |
| type | validated | Choix entre les données stockées brutes et validées. Valeurs autorisées : all (par défaut), bud et validated |
| years | 2019,2020 | Liste des années pour lesquelles on demande la quantité de données. |
| type | validated | Choix entre les données stockées brutes et validées. Valeurs autorisées : all (par défaut), bud et validated |
| years | 2019,2020 | Liste des années pour lesquelles on demande la quantité de données. |
## Détails sur la nomenclature des codes
......
......@@ -94,7 +94,7 @@ output-options :: [format=&lt;csv|request|sync|text&gt;]
</tr>
</tbody>
</table>
<h3 id="options-supplémentaires-spécifiques-aux-requêtes-country-send-et-timeseries">Options supplémentaires spécifiques aux requêtes country, send, et timeseries</h3>
<h3 id="options-supplémentaires-spécifiques-aux-requêtes-country-send-et-timeseries">Options supplémentaires spécifiques aux requêtes country, send et timeseries</h3>
<table>
<colgroup>
<col style="width: 10%" />
......@@ -112,7 +112,7 @@ output-options :: [format=&lt;csv|request|sync|text&gt;]
<tr class="odd">
<td style="text-align: left;">country</td>
<td style="text-align: left;">FR,GB</td>
<td style="text-align: left;">Filtre les réponses avec une liste des pays d’origine. La valeur est l’abréviation en deux lettres du pays.</td>
<td style="text-align: left;">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).</td>
</tr>
<tr class="even">
<td style="text-align: left;">media</td>
......
......@@ -11,9 +11,6 @@
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
<link rel="stylesheet" href="./static/resifws.css"/>
<a href="./local=fr"> <img src="./static/images/fr.png" alt="Anglais - Français"> </a>
</head>
......@@ -29,7 +26,7 @@ where :
request-options :: (request=&lt;country|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;type&gt;]
storage-options :: [year=&lt;year&gt;] &amp; [type=&lt;all|bud|validated&gt;]
send-options :: [country=&lt;country_code&gt;] &amp; [media=&lt;all|dataselect|seedlink&gt;]
output-options :: [format=&lt;csv|request|sync|text&gt;]
......@@ -40,5 +37,137 @@ output-options :: [format=&lt;csv|request|sync|text&gt;]
<p><a href="http://ws.resif.fr/resifws/statistics/1/query?request=send&media=dataselect&net=WI&country=IT">http://ws.resif.fr/resifws/statistics/1/query?request=send&amp;media=dataselect&amp;net=WI&amp;country=IT</a></p>
<p><a href="http://ws.resif.fr/resifws/statistics/1/query?request=country&media=dataselect&net=RA&country=IT,US,FR">http://ws.resif.fr/resifws/statistics/1/query?request=country&amp;media=dataselect&amp;net=RA&amp;country=IT,US,FR</a></p>
<p><a href="http://ws.resif.fr/resifws/statistics/1/query?request=country&media=seedlink&net=RA&starttime=2020-01-01">http://ws.resif.fr/resifws/statistics/1/query?request=country&amp;media=seedlink&amp;net=RA&amp;starttime=2020-01-01</a></p>
<h2 id="detailed-descriptions-of-each-query-parameter">Detailed descriptions of each query parameter</h2>
<table>
<colgroup>
<col style="width: 10%" />
<col style="width: 8%" />
<col style="width: 81%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Example</th>
<th style="text-align: left;">Discussion</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">net[work]</td>
<td style="text-align: left;">FR</td>
<td style="text-align: left;">Seismic network name.</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>
</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>
</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>
</tr>
<tr class="odd">
<td style="text-align: left;">start[time]</td>
<td style="text-align: left;">2010-01-10T00:00:00</td>
<td style="text-align: left;">Specify the responses that cover the time period after (and including) this time.</td>
</tr>
<tr class="even">
<td style="text-align: left;">end[time]</td>
<td style="text-align: left;">2011-02-11T01:00:00</td>
<td style="text-align: left;">Specify responses that cover the time period prior to this time.</td>
</tr>
<tr class="odd">
<td style="text-align: left;">format</td>
<td style="text-align: left;">json</td>
<td style="text-align: left;">The output format. Accepted values are text (the default) and csv.</td>
</tr>
<tr class="even">
<td style="text-align: left;">request</td>
<td style="text-align: left;">send</td>
<td style="text-align: left;">Type of statistic requested. Allowed values : <br> - <strong>country</strong> : the number of requests from each country <br> - <strong>send</strong> : the volume of distributed data by protocol <br> - <strong>storage</strong> : the volume of data stored <br> - <strong>timeseries</strong> : returns a timeseries with the country, the number and the volume of requests</td>
</tr>
</tbody>
</table>
<h3 id="additional-parameters-for-country-send-and-timeseries-request-options">Additional parameters for country, send, and timeseries request options</h3>
<table>
<colgroup>
<col style="width: 10%" />
<col style="width: 8%" />
<col style="width: 81%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Example</th>
<th style="text-align: left;">Discussion</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">country</td>
<td style="text-align: left;">FR,GB</td>
<td style="text-align: left;">Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2).</td>
</tr>
<tr class="even">
<td style="text-align: left;">media</td>
<td style="text-align: left;">seedlink</td>
<td style="text-align: left;">Protocol used to request data. Allowed values : all (the default), dataselect, and seedlink</td>
</tr>
</tbody>
</table>
<h3 id="additional-parameters-for-storage-request-option">Additional parameters for storage request option</h3>
<table>
<colgroup>
<col style="width: 10%" />
<col style="width: 8%" />
<col style="width: 81%" />
</colgroup>
<thead>
<tr class="header">
<th style="text-align: left;">Parameter</th>
<th style="text-align: left;">Example</th>
<th style="text-align: left;">Discussion</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">type</td>
<td style="text-align: left;">validated</td>
<td style="text-align: left;">Type of data. Allowed values : all (the default), bud, and validated</td>
</tr>
<tr class="even">
<td style="text-align: left;">years</td>
<td style="text-align: left;">2019,2020</td>
<td style="text-align: left;">List of years for which the volume of data is requested.</td>
</tr>
</tbody>
</table>
<h2 id="station-code-details">Station code details</h2>
<ul>
<li>network = one to two alphanumeric characters</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)
where:
YYYY :: four-digit year
MM :: two-digit month (01=January, etc.)
DD :: two-digit day (01 through 31)
T :: date-time separator
hh :: two-digit hour (00 through 23)
mm :: two-digit number of minutes (00 through 59)
ss :: two-digit number of seconds (00 through 59)
ssssss :: one to six-digit number of microseconds (0 through 999999)</code></pre>
</body>
</html>
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