princely-acts
/
documentation
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

organisation des datas

Browse Source
main
gwen 3 years ago
parent 742a56483d
commit 2c022deaf4
5 changed files with 233 additions and 213 deletions
Show Stats Download Patch File Download Diff File

214
source/data.rst
Unescape Escape View File

@ -1,209 +1,9 @@
Forme des datas
=================
Les données du projet `actes princiers`
===========================================
.. image:: img/exemple_parchemin_acte.jpg
Les données du projet *Actes princiers au royaume de France* sont des actes médiévaux - c'est-à-dire des documents qui fondent un droit pour une personne physique ou morale - émis par des princes de la fin de Moyen Âge. Ces princes sont des membres de la famille du roi de France (Orléans, Anjour, Berry, Bourgogne, Alençon, Bourbon) ou des grands feudataires (Bretagne, Savoie, Albret, Armagnac).
État actuel des actes
---------------------
.. index:: originaux, copies, minutes, vidimus, deperditum
- Les actes sont écrits au Moyen Âge sur des peaux de parchemin : lors que le parchemin nous est parvenu, on parle d'un **acte original** ou d'une **minute**.
- Les actes originaux ont pu être copiés et certifiés par un notaire au Moyen Âge ou à l'Époque Moderne : on parle alors d'un **vidimus**.
- Les actes orginaux ont pu être copiés : on parle alors d'une **copie**.
- Certains actes originaux sont totalement perdus, mais on en conserve des mentions plus ou moins détaillées ou des éditions modernes : on parle alors d'un **deperditum** (pluriel *deperdita*).
Conservation des actes
----------------------
.. index:: Archives nationales de France, archives départementales, archives municipales, Bibliothèque nationale de France, bibliothèques municipales
Le fichier : :file:`institutions.yaml`
- Les actes originaux, vidimés ou copiés sont conservés dans des institutions patrimoniales et y possèdent tous une cotation. Par exemple : *Archives départementales de la Côte d’Or, B 11942, cote 247*, *Bibliothèque nationale de France, ms. fr. 20389, cote 99*. Ces institutions patrimoniales peuvent être :
- des services d'archives : Archives nationales de France, services d'archives départementales ou municipales.
- des bibliothèques : Bibliothèque nationale de France, bibliothèques municipales
- S'il s'agit d'un deperditum :
- s'il s'agit d'édition, c'est la référence abrégée du livre dans lequel ils sont édités qui est donné.
- si le deperditum est mentionné dans un document d'archives, c'est la cote de ce document qui est donné.
- Dans le projet, les institutions sont listées dans le fichier `institutions.yaml`. Toutes les institutions listées ne contiennent pas un acte princier : il s'agit d'en lister le plus possible pour les futurs actes qui seront entrés dans la base.
Identifiants
-------------
.. index:: Albret, Alençon, Armagnac, Berry, Bourbon, Bourgogne, Bretagne, Orléans, Savoie
- Chaque maison princière a un identifiant :
.. list-table:: Identifiants des maisons princières
:widths: 25 25
:header-rows: 1
* - Maison
- Code
* - Albret
- alb
* - Alençon
- alb
* - Anjou
- anj
* - Armagnac
- arm
* - Berry
- bry
* - Bourbon
- brb
* - Bourgogne
- brg
* - Bretagne
- bre
* - Orléans
- orl
* - Savoie
- sav
- Chaque prénom porté par les princes et princesses a un identifiant,
- Celui des noms d'homme est composé de deux lettres ;
- Celui des noms de femme de trois lettres.
.. list-table:: Identifiants des prénoms des princes et princesses
:widths: 25 25
:header-rows: 1
* - Prénom
- Code
* - Alain
- al
* - Amédée
- am
* - Arthur
- ar
* - Bernard
- be
* - Charles
- ch
* - Édouard
- ed
* - François
- fr
* - Jean
- je
* - Louis
- lo
* - Philippe
- ph
* - Pierre
- pi
* - René
- re
* - Anne
- ann
* - Agnès
- agn
* - Béatrice
- bea
* - Blanche
- bla
* - Bonne
- bon
* - Catherine
- cat
* - Françoise
- fra
* - Jeanne
- jea
* - Marguerite
- mag
* - Marie
- mar
- Chaque prince ou princesse a un numéro d'ordre, en romain minuscule : `i`, `ii`, `iii`, `iv`, etc.
- L'identifiant des actes (`@xml:id` de `<TEI>`) est composé des trois éléments séparés d'un underscore et suivi de la date et d'une lettre.
- Actes de Charles Ier de Bourbon du 28 août 1427 : `brb_ch_i_1427_08_24a`.
Les datas dans le projet `princely-acts`
--------------------------------------------
Les datas dans le projet `princely-acts` sont centralisées dans un seul projet, le projet nommé `data`.
.. glossary::
data registry
Un data registry est storage de data centralisé, qui fait office de référentiel de données. Ce référentiel peut être alors utilisé partout ailleurs dans les autres projets qui ont besoin d'utiliser les datas **en lecture**.
.. note:: Dans le projet `princely-acts`, le référentiel de données s'appelle `princely-acts/data` et est un dépôt git.
Ce projet `data` **est la seule et unique source des datas**.
.. important:: Ne jamais dupliquer les datas ! Elles sont dans un seul
et unique data registry.
Pour réutilser les données **sans les dupliquer**, par exemple dans le projet `princely-acts/datascience`, il est proposé d'utiliser
la fonctionnalité
`git subtree <https://manpages.debian.org/bullseye/git-man/git-subtree.1.en.html>`_ de git, puisque le choix a été fait d'utiliser git comme data registry.
Git subtree
----------------
Voici la procédure d'import des datas depuis le dépôt `princely-acts/data`
vers le dépot `princely-acts/datascience` par exemple :
- aller dans le dépôt `princely-acts/datascience`
- ajouter **à la racine du projet** le remote suivant :
::
datascience $ git remote add data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git
- vérifiez que le remote a bien été ajouté avec la commande :
::
datascience $ git remote -v
data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git (fetch)
data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git (push)
origin git@gitlab.huma-num.fr:medieval-acts/datascience.git (fetch)
origin git@gitlab.huma-num.fr:medieval-acts/datascience.git (push)
- ensuite, vous pouvez ajouter le subtree qui va pointer sur les datas
avec la commande suivante (placez-vous toujours à la racine du projet)
::
datascience $ git subtree add --prefix actes-princiers/data/01_raw data main --squash
.. important:: Il faut que le dossier `actes-princiers/data/01_raw` n'existe pas (ne soint pas présent) dans le projet `datascience`, sinon le pull ne va fonctionner.
.. note:: l'option `--squash` permet de ne pas ajouter l'historique du projet `data` au projet `datascience`
- Vous pouvez ensuite utiliser les datas du projet `data` depuis le projet `datascience`.
Data update
------------
Si une nouvelle version des datas a été releasée, pour récupérer ces datas depuis le projet `datascience`, lancer cette commande **à la racine du projet** :
::
git subtree pull --prefix actes-princiers/data/01_raw data main --squash
X11 forwarding request failed on channel 0
Depuis gitlab.huma-num.fr:medieval-acts/princely-acts/data
* branch main -> FETCH_HEAD
.. toctree::
:maxdepth: 1
data_description
data_organisation
xml

143
source/data_description.rst
Unescape Escape View File

@ -0,0 +1,143 @@
Description des données du projet
======================================
Forme des datas
------------------
.. image:: img/exemple_parchemin_acte.jpg
Les données du projet *Actes princiers au royaume de France* sont des actes médiévaux - c'est-à-dire des documents qui fondent un droit pour une personne physique ou morale - émis par des princes de la fin de Moyen Âge. Ces princes sont des membres de la famille du roi de France (Orléans, Anjour, Berry, Bourgogne, Alençon, Bourbon) ou des grands feudataires (Bretagne, Savoie, Albret, Armagnac).
État actuel des actes
---------------------
.. index:: originaux, copies, minutes, vidimus, deperditum
- Les actes sont écrits au Moyen Âge sur des peaux de parchemin : lors que le parchemin nous est parvenu, on parle d'un **acte original** ou d'une **minute**.
- Les actes originaux ont pu être copiés et certifiés par un notaire au Moyen Âge ou à l'Époque Moderne : on parle alors d'un **vidimus**.
- Les actes orginaux ont pu être copiés : on parle alors d'une **copie**.
- Certains actes originaux sont totalement perdus, mais on en conserve des mentions plus ou moins détaillées ou des éditions modernes : on parle alors d'un **deperditum** (pluriel *deperdita*).
Conservation des actes
----------------------
.. index:: Archives nationales de France, archives départementales, archives municipales, Bibliothèque nationale de France, bibliothèques municipales
Le fichier : :file:`institutions.yaml`
- Les actes originaux, vidimés ou copiés sont conservés dans des institutions patrimoniales et y possèdent tous une cotation. Par exemple : *Archives départementales de la Côte d’Or, B 11942, cote 247*, *Bibliothèque nationale de France, ms. fr. 20389, cote 99*. Ces institutions patrimoniales peuvent être :
- des services d'archives : Archives nationales de France, services d'archives départementales ou municipales.
- des bibliothèques : Bibliothèque nationale de France, bibliothèques municipales
- S'il s'agit d'un deperditum :
- s'il s'agit d'édition, c'est la référence abrégée du livre dans lequel ils sont édités qui est donné.
- si le deperditum est mentionné dans un document d'archives, c'est la cote de ce document qui est donné.
- Dans le projet, les institutions sont listées dans le fichier `institutions.yaml`. Toutes les institutions listées ne contiennent pas un acte princier : il s'agit d'en lister le plus possible pour les futurs actes qui seront entrés dans la base.
Identifiants
-------------
.. index:: Albret, Alençon, Armagnac, Berry, Bourbon, Bourgogne, Bretagne, Orléans, Savoie
- Chaque maison princière a un identifiant :
.. list-table:: Identifiants des maisons princières
:widths: 25 25
:header-rows: 1
* - Maison
- Code
* - Albret
- alb
* - Alençon
- alb
* - Anjou
- anj
* - Armagnac
- arm
* - Berry
- bry
* - Bourbon
- brb
* - Bourgogne
- brg
* - Bretagne
- bre
* - Orléans
- orl
* - Savoie
- sav
- Chaque prénom porté par les princes et princesses a un identifiant,
- Celui des noms d'homme est composé de deux lettres ;
- Celui des noms de femme de trois lettres.
.. list-table:: Identifiants des prénoms des princes et princesses
:widths: 25 25
:header-rows: 1
* - Prénom
- Code
* - Alain
- al
* - Amédée
- am
* - Arthur
- ar
* - Bernard
- be
* - Charles
- ch
* - Édouard
- ed
* - François
- fr
* - Jean
- je
* - Louis
- lo
* - Philippe
- ph
* - Pierre
- pi
* - René
- re
* - Anne
- ann
* - Agnès
- agn
* - Béatrice
- bea
* - Blanche
- bla
* - Bonne
- bon
* - Catherine
- cat
* - Françoise
- fra
* - Jeanne
- jea
* - Marguerite
- mag
* - Marie
- mar
- Chaque prince ou princesse a un numéro d'ordre, en romain minuscule : `i`, `ii`, `iii`, `iv`, etc.
- L'identifiant des actes (`@xml:id` de `<TEI>`) est composé des trois éléments séparés d'un underscore et suivi de la date et d'une lettre.
- Actes de Charles Ier de Bourbon du 28 août 1427 : `brb_ch_i_1427_08_24a`.

77
source/data_organisation.rst
Unescape Escape View File

@ -0,0 +1,77 @@
Organisation des données du projet
======================================
Principes de base
----------------------
.. important:: La règle de base en datascience est que les datas
sont centralisées en un point d'entrée unique
appellé le :term:`data registry`.
Les datas dans le projet `princely-acts` sont centralisées dans un seul projet, le projet nommé `data`.
.. glossary::
data registry
Un data registry est storage de data centralisé, qui fait office de référentiel de données. Ce référentiel peut être alors utilisé partout ailleurs dans les autres projets qui ont besoin d'utiliser les datas **en lecture**.
.. note:: Dans le projet `princely-acts`, le référentiel de données s'appelle `princely-acts/data` et est un dépôt git.
Ce projet `data` **est la seule et unique source des datas**.
.. important:: Ne jamais dupliquer les datas ! Elles sont dans un seul
et unique data registry.
Pour réutilser les données **sans les dupliquer**, par exemple dans le projet `princely-acts/datascience`, il est proposé d'utiliser
la fonctionnalité
`git subtree <https://manpages.debian.org/bullseye/git-man/git-subtree.1.en.html>`_ de git, puisque le choix a été fait d'utiliser git comme data registry.
Git subtree
----------------
Voici la procédure d'import des datas depuis le dépôt `princely-acts/data`
vers le dépot `princely-acts/datascience` par exemple :
- aller dans le dépôt `princely-acts/datascience`
- ajouter **à la racine du projet** le remote suivant :
::
datascience $ git remote add data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git
- vérifiez que le remote a bien été ajouté avec la commande :
::
datascience $ git remote -v
data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git (fetch)
data git@gitlab.huma-num.fr:medieval-acts/princely-acts/data.git (push)
origin git@gitlab.huma-num.fr:medieval-acts/datascience.git (fetch)
origin git@gitlab.huma-num.fr:medieval-acts/datascience.git (push)
- ensuite, vous pouvez ajouter le subtree qui va pointer sur les datas
avec la commande suivante (placez-vous toujours à la racine du projet)
::
datascience $ git subtree add --prefix actes-princiers/data/01_raw data main --squash
.. important:: Il faut que le dossier `actes-princiers/data/01_raw` n'existe pas (ne soint pas présent) dans le projet `datascience`, sinon le pull ne va fonctionner.
.. note:: l'option `--squash` permet de ne pas ajouter l'historique du projet `data` au projet `datascience`
- Vous pouvez ensuite utiliser les datas du projet `data` depuis le projet `datascience`.
Data update
------------
Si une nouvelle version des datas a été releasée, pour récupérer ces datas depuis le projet `datascience`, lancer cette commande **à la racine du projet** :
::
git subtree pull --prefix actes-princiers/data/01_raw data main --squash
X11 forwarding request failed on channel 0
Depuis gitlab.huma-num.fr:medieval-acts/princely-acts/data
* branch main -> FETCH_HEAD

3
source/index.rst
Unescape Escape View File

@ -4,11 +4,10 @@ Projet Actes Princiers
.. toctree::
:maxdepth: 1
data
kedro
install
pipeline
data
xml
coding_standards
pipeline_actes_princiers

9
source/xml.rst
Unescape Escape View File

@ -1,9 +1,10 @@
Les documents XML
======================
Manipuldations générales sur les documents XML
===================================================
dans `data/01_raw/houses`
XML valide et XML bien formé
--------------------------------
le XML est **bien formé**
Le XML est **bien formé**
`xmllint --noout *.xml`

Write Preview
Loading…
Cancel
Save