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

doc update

parent a2673529
Pipeline #68012 passed with stage
in 2 minutes and 17 seconds
......@@ -141,7 +141,7 @@ def bode_plot(params, freqs, cpx_response, inventory):
def get_input_units_type(params, response):
""" Returns the unit type should be VEL, ACC or DISP. """
"""Returns the unit type should be VEL, ACC or DISP."""
params["input_units"] = response.instrument_sensitivity.input_units
# logging.debug("input_units: " + params["input_units"])
......@@ -162,7 +162,7 @@ def get_input_units_type(params, response):
def get_complex_response(params, response):
""" Returns the complex instrumental response. """
"""Returns the complex instrumental response."""
sampling_rates = response.get_sampling_rates()
last_stage = max(sampling_rates.keys())
......
......@@ -4,11 +4,11 @@ This service provides access to the sensor instrumental responses of the RESIF s
## Query usage
/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options)
/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options) [nodata=404]
where:
channel-options :: (net=<network> & sta=<station> & loc=<location> & cha=<channel>)
channel-options :: (net=<network>) (sta=<station>) (loc=<location>) (cha=<channel>)
time-option :: (time=<date>)
frequency-options :: [minfreq=<freq-Hz>] [maxfreq=<freq-Hz>] [nfreq=<number-of-frequencies>] [spacing=<lin|log>]
units-options :: [units=<def|dis|vel|acc>]
......@@ -24,12 +24,12 @@ This service provides access to the sensor instrumental responses of the RESIF s
## Detailed descriptions of each query parameter
| Parameter | Example | Discussion |
| :--------- | :------- | :----------------------------------------------------------------------------- |
| net[work] | FR | Seismic network name. |
| sta[tion] | CIEL | Station name. |
| loc[ation] | 00 | Location code. Use loc=-- for empty location codes. |
| cha[nnel] | HHZ | Channel Code. |
| Parameter | Example | Discussion |
| :--------- | :------- | :--------------------------------------------------------------------------------|
| net[work] | FR | Seismic network name. |
| sta[tion] | CIEL | Station name. |
| loc[ation] | 00 | Location code. Use loc=-- for empty location codes. |
| cha[nnel] | HHZ | Channel Code. |
| time | 2017-01-01T00:00:00 | Evaluate the response at the given time. If not specified, the current time is used. |
| minfreq | 0.001 | The minimum frequency (Hz) at which response will be evaluated. |
| maxfreq | 100 | The maximum frequency (Hz) at which response will be evaluated. Defaults to the channel sample rate or the frequency of sensitivity, whichever is larger. |
......@@ -41,15 +41,7 @@ This service provides access to the sensor instrumental responses of the RESIF s
| annotate | false | Displays the sensitivity, the frequency and sensitivity frequency. |
| degrees | false | Displays the phase in degrees or in radians. |
| format | plot | Output format. Must be: __fap__ (three column ASCII: frequency, amplitude, phase), __cs__ (three column ASCII: frequency, real, imaginary), __plot__ (amplitude and phase plot), __plot-amp__ (amplitude only plot), __plot-phase__ (phase only plot). |
## Station code details
The four parameters (network, station, location, channel) determine channels of interest.
- network = one to two alphanumeric characters
- station = one to five alphanumeric characters
- location = two alphanumeric characters
- channel = three alphanumeric characters
| nodata | 404 | Specify which HTTP status code is returned when no data is found (204 or 404) | 204 |
## Date and time formats
......
......@@ -4,11 +4,11 @@ Ce service donne accès aux réponses instrumentales des capteurs du réseau sis
## Utilisation de la requête
/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options)
/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options) [nodata=404]
où :
channel-options :: (net=<network> & sta=<station> & loc=<location> & cha=<channel>)
channel-options :: (net=<network>) (sta=<station>) (loc=<location>) (cha=<channel>)
time-option :: (time=<date>)
frequency-options :: [minfreq=<freq-Hz>] [maxfreq=<freq-Hz>] [nfreq=<number-of-frequencies>] [spacing=<lin|log>]
units-options :: [units=<def|dis|vel|acc>]
......@@ -24,12 +24,12 @@ Ce service donne accès aux réponses instrumentales des capteurs du réseau sis
## Descriptions détaillées de chaque paramètre de la requête
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :------------------------------------------------------------------------------ |
| net[work] | FR | 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. |
| cha[nnel] | HHZ | Code de canal. |
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :---------------------------------------------------------------------------- |
| net[work] | FR | Nom du réseau sismique. |
| sta[tion] | CIEL | Nom de la station. |
| loc[ation] | 00 | Code de localisation. Utilisez loc=-- pour les codes de localisations vides. |
| cha[nnel] | HHZ | Code de canal. |
| time | 2017-01-01T00:00:00 | La réponse est évaluée à l'instant donné. Sans précision, le temps actuel est utilisé. |
| minfreq | 0.001 | Fréquence minimum à laquelle la réponse sera évaluée. Par défaut à 0.00001 Hz. |
| maxfreq | 100 | Fréquence maximum à laquelle la réponse sera évaluée. Par défaut la valeur la plus grande entre la fréquence d'échantillonnage et la fréquence de sensibilité. |
......@@ -42,14 +42,6 @@ Ce service donne accès aux réponses instrumentales des capteurs du réseau sis
| degrees | false | Affiche la phase en degrés ou en radians. |
| format | plot | Format de sortie du fichier : __fap__ (trois colonnes au format texte : fréquence, amplitude, phase), __cs__ (trois colonnes au format texte : fréquence, partie réelle, partie imaginaire), __plot__ (amplitude et phase du diagramme de bode), __plot-amp__ (amplitude seule du diagramme de bode), __plot-phase__ (phase seule du diagramme de bode). |
## Détails sur la nomenclature des codes
- NETWORK : 1 à 2 caractères alphanumériques. 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,11 +21,11 @@
<h1 id="webservice-evalresp">Webservice evalresp</h1>
<p>Ce service donne accès aux réponses instrumentales des capteurs du réseau sismique RESIF.</p>
<h2 id="utilisation-de-la-requête">Utilisation de la requête</h2>
<pre><code>/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options)
<pre><code>/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options) [nodata=404]
où :
channel-options :: (net=&lt;network&gt; &amp; sta=&lt;station&gt; &amp; loc=&lt;location&gt; &amp; cha=&lt;channel&gt;)
channel-options :: (net=&lt;network&gt;) (sta=&lt;station&gt;) (loc=&lt;location&gt;) (cha=&lt;channel&gt;)
time-option :: (time=&lt;date&gt;)
frequency-options :: [minfreq=&lt;freq-Hz&gt;] [maxfreq=&lt;freq-Hz&gt;] [nfreq=&lt;number-of-frequencies&gt;] [spacing=&lt;lin|log&gt;]
units-options :: [units=&lt;def|dis|vel|acc&gt;]
......@@ -41,7 +41,7 @@ output-options :: (format=&lt;fap|cs|plot|plot-amp|plot-phase&gt;)
<colgroup>
<col style="width: 10%" />
<col style="width: 7%" />
<col style="width: 82%" />
<col style="width: 81%" />
</colgroup>
<thead>
<tr class="header">
......@@ -64,7 +64,7 @@ output-options :: (format=&lt;fap|cs|plot|plot-amp|plot-phase&gt;)
<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.</td>
<td style="text-align: left;">Code de localisation. Utilisez loc=-- pour les codes de localisations vides.</td>
</tr>
<tr class="even">
<td style="text-align: left;">cha[nnel]</td>
......@@ -128,13 +128,6 @@ output-options :: (format=&lt;fap|cs|plot|plot-amp|plot-phase&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. 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,11 +21,11 @@
<h1 id="webservice-evalresp">Webservice evalresp</h1>
<p>This service provides access to the sensor instrumental responses of the RESIF seismic network.</p>
<h2 id="query-usage">Query usage</h2>
<pre><code>/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options)
<pre><code>/query? (channel-options) [time-option] [frequency-options] [units-options] [plots-options] (output-options) [nodata=404]
where:
channel-options :: (net=&lt;network&gt; &amp; sta=&lt;station&gt; &amp; loc=&lt;location&gt; &amp; cha=&lt;channel&gt;)
channel-options :: (net=&lt;network&gt;) (sta=&lt;station&gt;) (loc=&lt;location&gt;) (cha=&lt;channel&gt;)
time-option :: (time=&lt;date&gt;)
frequency-options :: [minfreq=&lt;freq-Hz&gt;] [maxfreq=&lt;freq-Hz&gt;] [nfreq=&lt;number-of-frequencies&gt;] [spacing=&lt;lin|log&gt;]
units-options :: [units=&lt;def|dis|vel|acc&gt;]
......@@ -126,16 +126,13 @@ output-options :: (format=&lt;fap|cs|plot|plot-amp|plot-phase&gt;)
<td style="text-align: left;">plot</td>
<td style="text-align: left;">Output format. Must be: <strong>fap</strong> (three column ASCII: frequency, amplitude, phase), <strong>cs</strong> (three column ASCII: frequency, real, imaginary), <strong>plot</strong> (amplitude and phase plot), <strong>plot-amp</strong> (amplitude only plot), <strong>plot-phase</strong> (phase only plot).</td>
</tr>
<tr class="even">
<td style="text-align: left;">nodata</td>
<td style="text-align: left;">404</td>
<td style="text-align: left;">Specify which HTTP status code is returned when no data is found (204 or 404)</td>
</tr>
</tbody>
</table>
<h2 id="station-code-details">Station code details</h2>
<p>The four parameters (network, station, location, channel) determine channels of interest.</p>
<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)
......
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