Sea level data archaeology at Socoa (Saint Jean-de-Luz, France)

1. Description

This repository contains the data, notebooks, and documents covering the archeology and rescue of sea level observations at Socoa tide gauge (Saint Jean-de-Luz, Southwestern France, Latitude : 43.39524, Longitude : -1.68162). The dataset is complementary to the paper (henceforth "data paper") titled "Extension of high temporal resolution sea level time series at Socoa (Saint Jean-de-Luz, France) back to 1875".

Authors: Md Jamal Uddin Khan, Inge Van Den Beld, Guy Woppelmann, Laurent Testut, Alexa Latapy, Nicolas Pouvreau

For up-to-date sea level timeseries, users are also requested to visit the SHOM data distribution portal linked in the Related identifier section below.

The data and source-codes presented here is open-access. Please consider citing the data paper if you use the data. More information is given in the Data-use section below.

A brief structure of the files contained in this repository is shown below, and a brief descriptions is given in the following sections -

|- data
    |- auxilary
        |- brest_data.shom.fr/
        |- santander_marcos_etal.dat
    |- socoa
        |- data.shom.fr/
        |- corrections.csv
        |- corrections_marigram.csv
        |- corrections_registry.csv
        |- data_inventory.csv
        |- socoa_L0.csv
        |- socoa_L1.csv
        |- socoa_L2.csv
        |- socoa_L2_nominal.csv
        |- socoa_L3.csv
        |- socoa_L4.csv
        |- socoa_raw.txt
|- documents
    |- archive_records
        |- AD64__Pau_4S 33.docx
        |- Archives_Shom_plusieursCotes.docx
        |- SHD_Brest_MB3W.docx
        |- SHD_Rochefort_7JJ418-7JJ1551.docx
        |- SHD_Vincennes_plusieurCotes.docx
    |- tidegauge_journal
        |- <year>_Socoa_Notes_Registres.docx
    |- inventory.xlsx
|- figures
    |- figure01
    |- ...
    |- figure 06
    |- supp
|- notebooks
    |- 01_data_processing.ipynb
    |- 02_buddy_checking.ipynb
    |- 03_trend_analysis.ipynb
|- README.md

2. Data and codes

2.1 Data (/data)

Data directory (/data) contains two folder - auxilary, and socoa.

/data/socoa contains raw data (socoa_raw.txt) as well as processed dataset (socoa_L*.csv). For research application, the use of socoa_L4.csv is recommended. It also contains information regarding the data inventory (`data_inventory.csv`), and the corrections applied during the processing (corrections_*.csv). A snapshot of data from https://data.shom.fr (April 2022) is also available in the the /data/socoa/data.shom.fr directory.

/data/auxilary contains the auxilary dataset used for analysis and comparison in the data paper. Brest dataset, /data/auxilary/brest_data.shom.fr, is retrieved from https://data.shom.fr. Monthly sea level at Santander, /data/auxilary/santander_marcos_etal.dat, comes from the dataset published by Marcos et al. (2021) - see data paper for reference.

2.2 Documents (/documents)

The /documents folder contains supplimentary documents related to the dataset.

/documents/tidegauge_journal contains the extraction from the tide gauge journal year by year. The files are named as – YEAR_Socoa_Notes_Registres.docx where YEAR is the 4-digit year.

/documents/archive_records contains the excerpts of metadata documents from the various archives. For 5 archives, 5 separate files are provided. These archives are and file names are –

1. Service historique de la Défense (SHD) at Brest (SHD-Brest): SHD_Brest_MB3W.docx
2. Service historique de la Défense (SHD) at Rochefort (SHD-Rochefort): SHD_Rochefort_7JJ418-7JJ1551.docx
3. Service historique de la Défense (SHD) at Vincennes (SHD-Vincennes): SHD_Vincennes_plusieurCotes.docx
4. Archives des Pyrénées-Atlantiques (AD64): AD64_Pau_4S 33.docx
5. SHOM archive: Archives_Shom_plusieursCotes.docx

/documents/inventory.xlsx gives an overall inventory of the historic documents catalogued.

2.3 Figures (/figures)

The figures directory (/figures) contains the figures presented in the accompanying data paper organized into individual directories for each figure. The most of the figures related to the analysis is generated using python and their source-code is provided in the /notebooks directory. In case where external graphical software has been used for generating the final image is provided inside the directory for each individual figure.

2.4 Codes (/notebooks)

The codes used in processing this data is provided in the `/notebooks` directory. The full code is segmented into three self-contained python/jupyter notebooks -

1. Data processing (01_data_processing.ipynb)
2. Buddy checking (02_buddy_checking.ipynb)
3. Trend analysis (03_trend_analysis.ipynb)

The python environment necessary for running the notebooks can be created using conda (https://www.anaconda.com/products/distribution) with the following commands -

conda create -n socoa python=3.7 numpy scipy statsmodels cartopy netcdf4 pandas xarray jupyter
conda activate socoa
pip install utide==0.2.6
jupyter-notebook

3. Data-use information

Citation: TBD (Earth System Science Data)

Use rights: The data and source-code is freely available to anyone. Please consider citing the data paper using the citation above.

License: Creative Commons Attribution 4.0 International (CC BY 4.0)

4. Related identifiers

• SHOM historical dataset portal: http://refmar.shom.fr/dataRescue/HTML/FR/SOCOA%20(SAINT-JEAN-DE-LUZ).html
• SHOM data distribution portal: http://dx.doi.org/10.17183/REFMAR#95