Polytech CAO

h1. Ressources Proteus

{{toc}}

bq. Cette page traite des la maintenance et des gestions de versions des librairies. Les details concernant l'utilisation de Proteus sont regroupés la: [[Proteus_Tutorial|Utilisation de Proteus]]

bq. *Un librairie est constitué d'un couple [fichier.LIB / répertoire] le fichier et le répertoire doivent avoir le même non. Les deux doivent IMPÉRATIVEMENT être envoyé au serveur en même temps.*

h2. Gestion des versions des librairies

Les librairies de Proteus sont versionnées. Un serveur centralise et conserve l'ensemble des librairies, il conserve aussi un historique des modifications.

La gestion des versions est assurée par SVN. La gestion des versions est effectuée en utilisant des scripts clients, spécifiques à quelques client Svn tel que Tortoise Svn.

bq. *Les détails données ici imposent que "tortoise Svn soit intallé":http://tortoisesvn.net/downloads.html sur la machine de l'utilisateur.*

L'adresse du dépot est : https://forge.clermont-universite.fr/svn/cao/trunk/proteus

h2. Mise à jour des librairies

Après la mise en place, des modifications et des corrections peuvent être apportées sur le serveur. 

Pour mettre à jour votre copie locale de librairies utilisez la commande update (mise à jour) de tortoise SVN.

Cette opération ne peut être effectuée que si Proteus est complètement fermé.

> Un script de décomposition et un script de reconstruction seront exécutés lors de cette opération. Une boite de dialogue risque d’apparaître. Autorisez l’exécution de ces deux scripts.

Il faut réaliser cette opération régulièrement ( en début de séance), ou bien dès qu'une modification importante a été faite.

h2. Publication de vos travaux

Lorsque qu'un composant a été modifié, crée ou supprimé, il faut mettre à jour le serveur.

Les librairies modifiés sont marquées par une marque rouge par tortoise SVN.

bq. Normalement seule la librairie _etudiants.LIB_ et éventuellement vos librairies personnelles devraient être modifiées. Si ce n'est pas le cas se reporter à l'annulation de modifications.

Pour cela utiliser la fonction commit (livrer) de tortoise SVN. Cette opération est cependant un peu complexe.

> Un script de décomposition et un script de reconstruction seront exécutés lors de cette opération. Une boite de dialogue risque d’apparaître. Autorisez l’exécution de ces deux scripts.

> Si lors d'une opération de Commit, seul le fichier .LIB ou seul le répertoire apparait, ne pas continuer l’opération.

ATTENTION: Lors d'un commit vous modifiez les fichiers sur le Serveur, TOUT les utilisateurs seront impactés par vos modifications. Faites donc extrêmement attention lors d'un Commit:

# Vérifiez que les fichiers proposés par l’outil sont bien ceux que vous avez modifié, et uniquement ceux là,

# Si d'autres fichiers apparaissent dé-sélectionnez les,

# Chaque Commit doit contenir un commentaire, expliquant succinctement quelles modifications vous avez fait et pourquoi

# Chaque Commit doit être élémentaire. Si vous avez fait de nombreuses modifications essayez de faire un commit à chaque fin de modification.

h2. Mise en place des librairies

Lors de la première utilisation des librairies il faut copier celles ci sur la machine locale et assurer le lien avec le Dépôt.

Choisir un répertoire ou les librairies seront installées par exemple _c:\users\ge\cao_

Note: Sur les machines de travaux pratiques de Cao les librairies sont installées dans _e:\CAO\proteus\_ 

Avec le menu contextuel (bouton droit de la souris) choisir SVN CheckOut pour "descendre" une copie de travail des librairies depuis le serveur.

L'adresse du repository (dépôt) étant : *https://forge.clermont-universite.fr/svn/cao/trunk/proteus*, choisissez +proteus+ comme répertoire local.

Vous avez alors sur votre machine la dernière version des librairies.

Les librairies doivent être dans un état "normal" c'est a dire non modifiées par rapport au serveur. Les icônes sont donc toutes vertes.

h2. Configuration de Proteus

Dans Système -> Réglages Systèmes

* Ajouter _c:\users\ge\cao\Proteus\Librairies\Template_ à la liste des Dossiers de Gabarits

* Ajouter _c;\users\ge\cao\Proteus\Librairies_ à la liste des Dossiers Bibliothèques

Dans l'onglet Réglage du Simulateur

* Ajouter _c:\users\ge\CAO\Proteus\Librairies\Models_ à la liste des chemins des Modules et Modèles de Simulation

h2. Librairie de Travail Enseignants et étudiants

Vous pouvez dès lors travailler. Attention cependant à sauvegarder vos composants et empreintes dans la bonne librairie.

* Librairie etudiant_sch/pcb.LIB : Librairie versionnée et destinée aux étudiants. Attention à ne pas modifier les composants de vos collègues et à ne pas faire de modifications qui risqueraient de compromettre les cartes d'autres utilisateurs.

* Librairie ge_sch/pcb.LIB : Librairie de référence de l'école. Les composants dans cette librairie sont fiables et ont étés validés. Aucune modification ne doit être apportée à cette librairie sans validation.

* Librairies nominatives_sch/pcb.LIB : Equivalent de la librairie etudiant mais spécifique à un enseignant, ou un utilisateur particulier. Ne pas toucher au contenu de ces librairies sauf avec l'aval du propriétaire.

h2. Librairies de Test, Librairies Locales

Il est possible de créer de nouvelles librairies locales avec l'outil Proteus. 

Pour créer une bibliothèque Dans le Menu Bibliothèque -> Gestionnaire de Bibliothèques -> Create Library

Attention a bien créer votre librairie dans le bon répertoire _c:\users\cao\proteus\Librairies_ par exemple.

Attention tant que la librairie n'a pas été ajouté au système de contrôle de version, elle ne sera pas versionnée et n'existera que sur la machine ou elle a été crée. 

Si le contenu de la librairie devient indispensable il faudra:

- Copier son contenu dans la librairie etudiant / ge / ...

- Demander la prise en compte de cette librairie par le système de versionnage (add / ajout dans tortoise svn).

bq. *Dans la mesure du possible essayez de travailler dans la librairie etudiants_sch/pcb.LIB*

Les composants crées et corrects seront ensuite déplacés dans la librairie ge_sch.lib et ge_pcb.lib par un enseignant, si et seulement si le composant a été correctement validé.

h2. Librairie de Travail Etudiants

Les étudiants travaillent en priorité sur la librairie _etudiants_sch.lib_ et _etudiants_pcb.lib_.

> Attention lors de la création d'un symbole, d'un boîtier, ou d'un package à bien sauvegarder dans la bonne librairie (etudiands_sch/pcb.LIB), en général le choix par défaut n'est pas le bon.

h2. Conflits

Attention si un composant sur lequel vous avez travaillé a dans la même période été modifié sur le serveur, il y aura un conflit. Le format des fichiers Proteus ne permet pas la résolution du conflit.

Il faudra alors perdre vos modifications locales (resolve using theirs), et les appliquer de nouveau sur le composant mis à jour. Ceci ne devrait pas se produire souvent si les librairies locales sont mis à jour régulièrement.

h2. Annulation de modifications

Si des modifications apparaissent par erreur sur les librairies / fichiers, il est possible de les annuler.

ATTENTION: Cette annulation entraînera la perte de tout travail effectué sur le fichier ! Il peut être judicieux de faire une sauvegarde du fichier à titre conservatoire.

Avec tortoise svn utiliser l'option REVERT pour annuler les modifications. Pour les librairies Proteus l'operation REVERT doit forcement être faite en même temps sur la librairie et sur le répertoire.

h3. Fin de projet / carte / travaux

Il faut impérativement penser à nettoyer la librairie etudiant en fin de projet. Penser à corriger les erreurs rencontrées dans vos composants pour éviter que la même erreur apparaissent de nouveau.

Si certains composants sont validés, vous pouvez demander à ce qu'ils soient placés dans la librairie ge_sch/pcb.LIB, ceci est un honneur ! Pensez à renseigner votre nom dans les proprités du composant, les générations d’étudiants vous en seront reconnaissantes !

[[Proteus Archive1]]