neurodata.io

neurodata.io

Ceci est le code du générateur de site statique pour neurodata.io

Conditions préalables

Au minimum, vous devrez installer les outils suivants :

1. Git
2. Grandir

Si vous n'avez pas Grow, vous pouvez l'installer en utilisant :

curl https://install.grow.io | bash

ou (à partir d'un environnement virtuel)

pip install grow

Notez que grow ne prend pas encore en charge Python 3.

Exécuter le serveur de développement

Avant de démarrer le serveur de développement, vous devrez peut-être installer les dépendances utilisées par votre projet. La commande grow install vous guide tout au long de cette procédure et tente de configurer votre environnement pour vous.

La commande grow run démarre votre serveur de développement. Vous pouvez apporter des modifications à vos fichiers de projet et les actualiser pour les voir immédiatement reflétées.

grow install
grow run

Bâtiment

Vous pouvez utiliser la commande grow build pour créer l'intégralité de votre site dans le répertoire build . C'est un bon moyen de tester et de vérifier le code généré.

grow build

Contribuer

Veuillez soumettre des demandes d'extraction pour deploy la branche.

[DEV/QC] Fichiers Bib et références

Il existe un fichier LaTeX qui intégrera les références dans un PDF, principalement pour le contrôle qualité. Il se trouve dans le répertoire racine et peut être construit en exécutant make dans le répertoire racine.

Rubrique d'ajout de bavoirs

Lors de l'ajout d'un nouvel ajout aux fichiers bibliographiques, la plupart des entrées bibliographiques normales fonctionneront, la seule étape supplémentaire étant l'ajout d'une valeur keywords . Les mots-clés à utiliser pour chaque fichier bibliographique sont affichés ci-dessous, car ils sont utilisés pour organiser le fichier. Règles générales :

• Lorsque vous ajoutez des entrées aux fichiers pubs.bib ou talks.bib, incluez une entrée appelée author+an , cela sert à souligner les membres du laboratoire et à mettre en gras le nom de Jovo dans les sections de publication de son CV. En regardant l'ordre des auteurs pour une entrée de bib, numérotez quels auteurs sont membres du laboratoire ( trainee ) et lesquels sont jovo ( highlight ). Par exemple:

 @article{example,
author = {<lab member> and <not lab member> and <jovo> and <lab member> and <not lab member>},
author+an = {1=trainee;4=trainee;3=highlight},
...

• N'ajoutez PAS de citation @incollection sauf si vous ajoutez un nouveau membre au fichier people.bib
• Assurez-vous que ce month est un nombre entier, car cela évite d'éventuels problèmes de commande.
• Évitez les symboles tels que & et $ dans vos entrées, car ils peuvent entraîner des problèmes lors de la compilation des dossards.

Catégories pour pubs.bib :

• Pour les articles évalués par des pairs acceptés et publiés : peer-reviewed
• Pour les articles actuellement en cours de révision : in-review
• Pour les communications de conférence : conference
• Pour les entrées de livre : book
• Pour les rapports techniques : tech
• Pour les résumés/posters : abspos
• Pour les autres publications : other
• Pour les articles sans Jovo comme auteur, mais toujours référencés sur le site : omit

catégories pour talks.bib :

• Pour les discussions locales : local
• Pour les discussions internationales : international

Catégories pour press.bib :

• N / A

Informations supplémentaires sur les membres de l'équipe

Toutes les informations concernant les membres de l'équipe pour la page neurodata.io/about/team/ du site Web et le CV de Jovo (neurodata.io/about/jovo, la section Mentorat) sont dérivées du fichier bib situé dans content/bibs/people.bib . Il est très important que chacun garde ses informations personnelles à jour, car cela figurera sur le CV de Jovo. En plus des informations ajoutées ici, vous devrez télécharger une image dans content/source/images/people et indiquer son nom dans la catégorie file (par exemple, john_doe.jpg ). Voir ci-dessous si vous souhaitez ajouter une personne au site Web qui ne devrait apparaître ni sur le CV ni sur la page Teams.

 @incollection{<ID>,
    author = {Full name},
    usera = {Job title},
    month = {Month, as an integer, that you started working},
    year = {starting year},
    number = {starting month/year -- ending month/year},
    series = {ending year},
    abstract = {What you do in the lab, 1-2 sentences, 3rd person},
    userb = {highest degree held},
    userc = {department/major, school},
    userd = {website category},
    keywords = {cv category},
    doi = {github username},
    note = {email address},
    url = {personal website (do not include https://)},
    usere = {training},
    file = {image name}
}

Certaines catégories peuvent être laissées vides si elles ne sont pas applicables, les catégories requises pour contenir des informations sont : <ID> , author , usera , month , year , number et userd . Quelques remarques supplémentaires :

• Les abréviations sont fortement encouragées pour userb et userc

• year et series doivent avoir les 4 chiffres de l'année (c'est-à-dire 2019, et non 19)

• number doit être au format {01/18 -- } si le membre de l'équipe est toujours membre du laboratoire, et {01/18 -- 04/21} s'il n'est plus membre.

• Les catégories pour userd sont (par ordre de placement sur la page des équipes) :

  • faculty
  • faculty - research
  • staff
  • postdoc
  • student
  • undergrad
  • associate
  • highschool

• Les catégories de keywords sont :

  • Mentorat du corps professoral du volet recherche = researchtrackfaculty
  • Chercheur scientifique = staffresearch
  • Boursier postdoctoral = postdoc
  • doctorat Étudiant = PhDstudent
  • Doctorant invité = visitingdoc
  • Étudiant à la maîtrise = MSstudent
  • Étudiant de premier cycle = undergrad
  • Lycéen = HS

• Votre image peut être trouvée ici () si vous êtes déjà sur le site

• Les entrées usere actuellement prises en charge sont :

  • safe-zone

Un exemple d'entrée est :

 @incollection{johndoe,
    author = {John Doe},
    usera = {Research Assistant},
    month = {7},
    year = {2019},
    number = {7/19 -- },
    series = {},
    abstract = {Lead developer on <project>, helping with <something>...},
    userb = {BSE},
    userc = {BME, JHU},
    userd = {student},
    keywords = {MS},
    doi = {jnydoe},
    note = {[email protected]},
    url = {www.heresjohnny.com},
    usere = {safe-zone},
    file = {john_doe.jpg}
}

Ajouter une personne qui ne devrait pas apparaître sur la page Teams ou sur le CV :

Pour ce faire, copiez simplement l'entrée ci-dessous (oui, il doit y avoir des espaces dans les sections number et series ) et modifiez les informations pertinentes. L' other spécification pour userd et keywords indique au site Web d'ignorer l'affichage de ces personnes sur la page Teams (bien qu'elles apparaissent lorsqu'elles sont référencées ailleurs) et au CV de les ignorer lors de la génération.

 @incollection{johndoe,
    author = {John Doe},
    usera = {},
    month = {},
    year = {},
    number = { },
    series = { },
    abstract = {},
    userb = {},
    userc = {},
    userd = {other},
    keywords = {other},
    doi = {},
    note = {[email protected]},
    url = {},
    usere = {},
    file = {john_doe.jpg}
}

Hébergement de fichiers sur le site :

ACTUELLEMENT EN DÉVELOPPEMENT

Compilation de la version pdf du CV pour la page personnelle de Jovo :

Vous pouvez compiler le pdf localement en exécutant la commande pdflatex sur le fichier jovo_cv_SOM.tex sous content/bibs/tex/ . Si vous avez apporté des modifications aux fichiers bib, vous devrez également exécuter la commande biber sur le fichier jovo_cv_SOM :

 biber jovo_cv_SOM
pdflatex jovo_cv_SOM.tex