Ajouter un outil ou un exemple de littérature

Sur cette page

Une contribution utile peut être modeste : identifier un modèle publié, localiser son code, améliorer une étape de configuration ou signaler un échec d'exécution. Un navigateur suffit pour proposer une source. Suivez le normes partagées.

Enregistrements du catalogue#

Les sources modifiables sont: tools.csv, papers.csv, et examples.csv. Les identifiants sont des noms stables en minuscules séparés par des tirets ; les listes d'identifiants utilisent des points-virgules. Gardez les ID d’exemple d’un outil cohérents avec les ID d’outil de l’exemple.

Pour un outil, enregistrez son but, la source et la documentation officielles, la licence de code source, les termes d'exécution/data/asset séparés, la disponibilité de la source et la date effectivement vérifiée. Ne pas assimiler un téléchargement gratuit à open source ou décrire la disponibilité du dépôt comme preuve de maintenance ou d'exécution. Inclure les outils de scène et les cadres d'optimisation lorsque cela est utile, tout en identifiant avec précision leur rôle.

Pour une référence, vérifier le titre, les auteurs, l'année, le type de publication et la DOI par rapport à un document principal. Enregistrez l'accès en texte intégral et les passages effectivement inspectés séparément de la vérification des métadonnées. Un document logiciel peut soutenir la description de l'outil; une demande doit être accompagnée d'un modèle, d'une méthode, d'une équation, d'une liste, d'une référence ou d'une expérience identifiables.

Par exemple, ajoutez un guide qui donne la question de recherche, la connexion exacte sur papier, la version de code/archive, l'environnement, les termes d'entrée, les commandes ou la voie d'exécution concrète, les fichiers de sortie attendus et les mesures de comparaison. Expliquez les différences par rapport à l'article. Utiliser un statut :

Statut dans le CSV Preuves requises
executed_adaptation Le code d'enseignement inclus est diffusé; conserver les paramètres, l'environnement, les extrants et les vérifications réelles. Cela n'affirme pas la reproduction sur papier.
upstream_instructions_checked les fichiers sources et les instructions d'exécution en amont inspectés; l'exécution est toujours en cours.
access_pending Citation ou objet localisé, mais un artefact nécessaire ne peut pas encore être inspecté. Indiquer exactement ce qui manque.

Utiliser la modèle d'enregistrement d'exécution pour une nouvelle course. Une allégation selon laquelle un résultat publié a été reproduit a également besoin d'un objectif précis, de méthodes et d'intrants assortis, d'une comparaison et d'une tolérance explicites, et d'un examen scientifique humain. Garder de nouvelles études de fond dans leurs propres dépôts de recherche.

Itinéraires de recherche pour le catalogue complet#

Les Inventaire des itinéraires papier à code enregistre les plans de construction séparément du catalogue d'exemple d'enseignement accepté. Modifier research/routes.json et préserver l'enregistrement des métadonnées primaires, l'emplacement sur papier, la relation code-papier, la version immuable lorsque disponible, l'accès en entrée, les commandes de construction, la cible de comparaison, les preuves d'exécution et les lacunes non résolues.

Un résultat papier candidat identifie ce qu'il faut reproduire ; un exemple de papier logiciel ou un didacticiel connexe a une relation plus étroite avec la recherche. Ne mettez pas à niveau un statut d'exécution sans un enregistrement d'exécution. Une comparaison cible publiée nécessite des entrées et des méthodes adaptées, un observable et une tolérance explicites et des preuves numériques conservées. L’examen scientifique humain reste distinct.

Courez python3 simulation-lab/research.py --write avant de régénérer le catalogue principal. Cela valide un itinéraire par outil de catalogue et génère les six guides de domaine et l'inventaire de parcours téléchargeable. De nouvelles recherches de fond font partie d'un dépôt d'études; cet inventaire est une planification commune de l'apprentissage et de la reproduction.

Essais de code-auteur et comparaisons numériques#

Les Campagne des candidats possède un enregistrement pour chacun des 21 outils sélectionnés. Conservez les échecs originaux, les versions de publication/document, les paramètres d'entrée assortis, les sorties et les hachages natifs et tout changement de code ou d'environnement. Une exécution de code d'auteur, une réplication de tiers maintenue, une adaptation, une analyse d'archives et une comparaison sur papier sélectionnée ont des exigences de preuve différentes.

Déclarez la règle observable et de comparaison avant de produire le résultat numérique. L'extraction ou la comparaison post-hoc révisée reste exploratoire, même si un rediffusion déterministe le suit. les cibles papier ont besoin d'emplacements de sources et d'une précision ou d'incertitude justifiées; un montage actuel ou une correspondance de sortie archivée doit conserver cette portée plus étroite. Vérifier la convergence et la faisabilité du résolveur séparément de l'état de sortie du processus. Consigner l'examen scientifique humain comme en attente jusqu'à ce qu'il soit réellement effectué.

Modifier reproductions/campaign.json et ses modèles guide originaux, puis se régénérer avec python3 simulation-lab/reproduce.py --write. Partagez uniquement les sorties explicitement réutilisables et préservez les termes d'actif, de modèle et d'exécution par fichier. Nouveaux exemples réussis d'utilisation executed_author_code ou, pour une cible sélectionnée de passage avec ses preuves, published_target_compared. Utilisation des analyses de sortie enregistrées analysed_saved_output. Ces statuts n’affirment jamais la reproduction sur papier entier ou l’acceptation humaine.

Régénérer et vérifier#

À partir de la racine du hub, en utilisant Python 3.10 ou plus récent:

python3 simulation-lab/reproduce.py --write
python3 simulation-lab/research.py --write
python3 simulation-lab/catalog.py --write
python3 simulation-lab/catalog.py

Ceci vérifie les identifiants, les références, les dates, les formats source-lien, les fichiers guides locaux et la fraîcheur du fichier généré. Il ne communique pas avec des sites externes ou ne vérifie pas les allégations scientifiques. Suivez la instructions pour la construction du site pour vérifier les liens rendus et la mise en page lors du changement de pages.

Soumettre une demande de tirage avec les sources que vous avez vérifiées, les commandes que vous avez exécutées, les résultats, les limites restantes, l'aide de l'agent matériel, et l'humain responsable. Ne téléchargez pas les PDF de la bibliothèque à moins que leurs termes de redistribution ne le permettent. Une DOI et un emplacement précis du passage suffisent pour citer un article restreint; utiliser les route de la demande de ressources lorsque l'accès est nécessaire.

Afficher la source sur GitHub