diff --git a/README.md b/README.md index d0ffd75..d580c97 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -# OpenStudio-Measures -([Français](#openstudio-measures)) +# Openstudio Measures + + đŸ‡«đŸ‡· [Français](#openstudio-measures) -This repository is a collection of [OpenStudio measures](https://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/), testing and simulation environment. The tools are used by NRC research staff in various activities. By sharing these tools, we aim to increase transparency in the work we are conducting to support Canadian industry, accelerate the +This repository is a collection of [OpenStudio measures](https://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/), testing and simulation environment. The tools are used by NRC research staff in various activities. By sharing these tools, we aim to increase transparency in the work we are conducting to support Canadian industry, accelerate the use of building simulation across the country, and hope they will prove to be useful for others further afield. -The primary project supporting the development of these measures is our support for decision makers in the [National Energy Code for -Buildings](https://nrc.canada.ca/en/certifications-evaluations-standards/codes-canada/codes-canada-publications). We encourage those wanting to -evaluate potential changes to the code to use and modify these measures, apply them to their models, etc to increase the evidence available for -decision makers. +The primary project supporting the development of these measures is our support for decision makers in the [National Energy Code for +Buildings](https://nrc.canada.ca/en/certifications-evaluations-standards/codes-canada/codes-canada-publications). We encourage those wanting to +evaluate potential changes to the code to use and modify these measures, apply them to their models, etc to increase the evidence available for +decision makers. -Note: the measures *may* work in the default [OpenStudio and PAT apps](https://www.openstudio.net/downloads) from the official NREL site, however some functionality +Note: the measures *may* work in the default [OpenStudio and PAT apps](https://www.openstudio.net/downloads) from the official NREL site, however some functionality will require the specific version of OpenStudio-Server created by the ‘server’ scripts within this repository. ## How to use this repository @@ -27,13 +28,13 @@ The environment is intended for developers to test their code before contributin The content of this repository is maintained to be consistent, i.e. the measures will be maintained to work with the version of OpenStudio-Server that the repository creates. This way users can be sure that the measures will work on their projects. -#### 4. Additional information +#### 4. Additional information - This repository relies on other actively developed projects; therefore, updates to dependencies done periodically. More information is available in [MAINTENANCE.md](MAINTENANCE.md). - More background information on this project, motivation, OpenStudio, and FAQ can be found in the wiki. ## Linkages to related projects -This repository builds on the functionality built into OpenStudio. This functionality has been expanded by other groups via various collections -of ‘measures’, for example as contained in the [Building Component Library](https://bcl.nrel.gov/) and the [BTAP](https://github.com/canmet-energy/btap) initiative from +This repository builds on the functionality built into OpenStudio. This functionality has been expanded by other groups via various collections +of ‘measures’, for example as contained in the [Building Component Library](https://bcl.nrel.gov/) and the [BTAP](https://github.com/canmet-energy/btap) initiative from NRCan. This repository contains measures from various sources: - Copied from the BCL. These copies are contained here for ease of use as PAT only refers to a single folder when searching for measures. Their names are prefixed with ‘bcl_’. The standard BCL license is contained in the measure folder. @@ -45,20 +46,20 @@ consistent and robust testing than is otherwise present in many BCL measures. Th is referenced in the ‘modeller info’ section of the measure. - Original content. These measures were created by NRC using the template measure. Their names are prefixed with ‘nrc_’. -The overall intent is to complement existing work in this area and provide additional support to industry and transparency in our work. To this -end we are more than willing to discuss separate licensing arrangements in addition to the default LGPLv3 although we may be restricted by the -original licensing for derived content. Specific restrictions relate to the use of the template measure (which is derived from LGPLv2 code in -OpenStudio-Standards and BTAP measures which are licensed under GPLv2; in general BCL measures have a non-restrictive license although many have +The overall intent is to complement existing work in this area and provide additional support to industry and transparency in our work. To this +end we are more than willing to discuss separate licensing arrangements in addition to the default LGPLv3 although we may be restricted by the +original licensing for derived content. Specific restrictions relate to the use of the template measure (which is derived from LGPLv2 code in +OpenStudio-Standards and BTAP measures which are licensed under GPLv2; in general BCL measures have a non-restrictive license although many have no specific license). -In addition the measures also make use of the [OpenStudio-Standards](https://github.com/NREL/openstudio-standards) repository. The ‘Canadian content’ -in OpenStudio-Standards is maintained by NRCan with contributions from NRC and others. Specifically we use the [nrcan_nrc](https://github.com/NREL/openstudio-standards/tree/nrcan_nrc) branch in this repository -which is branched off the nrcan branch. This allows us to test changes made to the nrcan branch before updating the nrcan_nrc branch to ensure that the -measures in this repository still function as intended. The changes added to the nrcan branch are eventually merged into the master branch of +In addition the measures also make use of the [OpenStudio-Standards](https://github.com/NREL/openstudio-standards) repository. The ‘Canadian content’ +in OpenStudio-Standards is maintained by NRCan with contributions from NRC and others. Specifically we use the [nrcan_nrc](https://github.com/NREL/openstudio-standards/tree/nrcan_nrc) branch in this repository +which is branched off the nrcan branch. This allows us to test changes made to the nrcan branch before updating the nrcan_nrc branch to ensure that the +measures in this repository still function as intended. The changes added to the nrcan branch are eventually merged into the master branch of OpenStudio-Standards (again NRCan conduct significant testing before updating their branch and committing changes to their branch). ## Support -There is no explicit support for use of this repository. However, if you plan on using the repository please contact us and we will endeavour to +There is no explicit support for use of this repository. However, if you plan on using the repository please contact us and we will endeavour to clarify/fix areas of confusion. If you find a bug or a measure is not working please create an issue and submit via this website. @@ -98,3 +99,54 @@ Voir [CONTRIBUTING.md](CONTRIBUTING.md) Sauf indication contraire, le code source de ce projet est protĂ©gĂ© par le droit d'auteur de la Couronne du gouvernement du Canada et distribuĂ© sous la [licence LGPLv3](LICENSE). + + + + + + +## Mesures OpenStudio + +Ce dĂ©pĂŽt regroupe des mesures OpenStudio, ainsi qu'un environnement de test et de simulation. Elles sont utilisĂ©es par notre Ă©quipe de recherche du CNRC dans diverses activitĂ©s, et nous les partageons avec l'espoir qu'elles pourront ĂȘtre utiles Ă  d'autres au Canada et au-delĂ . En partageant ces mesures, nous voulons rendre notre travail plus transparent et soutenir l'industrie canadienne en accĂ©lĂ©rant l'utilisation de la simulation de bĂątiments Ă  travers le pays. + +**Remarque:** ces mesures *peuvent* fonctionner avec les [applications OpenStudio et PAT](https://www.openstudio.net/downloads) de NREL, par dĂ©faut. Cependant, certaines fonctionnalitĂ©s nĂ©cessitent une version spĂ©cifique d'`openstudio-server` crĂ©Ă©e par les scripts `server` dans ce dĂ©pĂŽt. + +Le projet principal qui soutient le dĂ©veloppement de ces mesures est notre support aux dĂ©cideurs impliquĂ©s dans le [Code national de l'Ă©nergie pour BĂątiments](https://nrc.canada.ca/fr/certifications-evaluations-normes/codes-canada/publications-codes-canada). Nous invitons ceux qui souhaitent Ă©valuer d'Ă©ventuels changements au *Code* Ă  utiliser ces mesure dans leurs modĂšles, Ă  les modifier, les varier, etc., afin de recueillir davantage de donnĂ©es probantes Ă  l'intention des dĂ©cideurs. + +Nous entretenons ce dĂ©pĂŽt de maniĂšre cohĂ©rente, c'est-Ă -dire de maniĂšre Ă  ce que les mesures fonctionnent avec la version d'`openstudio-server` gĂ©nĂ©rĂ©e ici. Ainsi, les utilisateurs peuvent se fier au fait que les mesures demeureront compatibles avec leurs projets respectifs. + + +### Contexte et liens avec des projets connexes +Ce rĂ©fĂ©rentiel s'appuie sur les fonctionnalitĂ©s intĂ©grĂ©es Ă  OpenStudio. Cette fonctionnalitĂ© a Ă©tĂ© Ă©tendue par d'autres groupes via diverses collections +de « mesures », par exemple celles contenues dans la [Building Component Library](https://bcl.nrel.gov/) et l'initiative [BTAP](https://github.com/canmet-energy/btap) de +RNCan. Ce rĂ©fĂ©rentiel contient des mesures provenant de diverses sources : +- CopiĂ© de la BCL. Ces copies sont contenues ici pour faciliter l'utilisation car PAT ne fait rĂ©fĂ©rence qu'Ă  un seul dossier lors de la recherche de mesures. +Leurs noms sont prĂ©fixĂ©s par "bcl_". La licence BCL standard est contenue dans le dossier de mesure. +- CopiĂ© depuis BTAP. Ces copies sont contenues ici pour faciliter l'utilisation car PAT ne fait rĂ©fĂ©rence qu'Ă  un seul dossier lors de la recherche de mesures. +Leurs noms sont prĂ©fixĂ©s par "btap_". La licence BTAP standard est contenue dans le dossier de mesure. +- DĂ©rivĂ© de BCL/BTAP. Ces mesures ont Ă©tĂ© modifiĂ©es par rapport aux versions originales pour fonctionner avec la version d'openstudio-server ou pour fournir +fonctionnalitĂ© spĂ©cifique. De plus, les mesures ont Ă©tĂ© modifiĂ©es pour utiliser la fonctionnalitĂ© de la mesure modĂšle - cela fournit plus +des tests cohĂ©rents et robustes que ceux qui sont autrement prĂ©sents dans de nombreuses mesures BCL. Leurs noms sont prĂ©fixĂ©s par "nrc_" et la mesure d'origine +est rĂ©fĂ©rencĂ© dans la section « infos sur le modĂ©lisateur » de la mesure. +- Contenu original. Ces mesures ont Ă©tĂ© crĂ©Ă©es par le CNRC Ă  l'aide du modĂšle de mesure. Leurs noms sont prĂ©fixĂ©s par "nrc_". + +L'intention gĂ©nĂ©rale est de complĂ©ter les travaux existants dans ce domaine et de fournir un soutien supplĂ©mentaire Ă  l'industrie et la transparence de notre travail. Pour ça +fin, nous sommes plus que disposĂ©s Ă  discuter d'accords de licence distincts en plus de la LGPLv3 par dĂ©faut, bien que nous puissions ĂȘtre limitĂ©s par le +licence originale pour le contenu dĂ©rivĂ©. Des restrictions spĂ©cifiques concernent l'utilisation du modĂšle de mesure (qui est dĂ©rivĂ© du code LGPLv2 dans +les normes openstudio et les mesures BTAP sous licence GPLv2 ; en gĂ©nĂ©ral, les mesures BCL ont une licence non restrictive bien que beaucoup aient +pas de licence spĂ©cifique). + +De plus, la bibliothĂšque utilise le rĂ©fĂ©rentiel [openstudio-standards](https://github.com/NREL/openstudio-standards). Le « contenu canadien » +dans les normes openstudio est maintenu par RNCan avec des contributions du CNRC et d'autres. Plus prĂ©cisĂ©ment, nous utilisons la branche nrcan_nrc dans ce rĂ©fĂ©rentiel +qui est dĂ©rivĂ© de la branche nrcan. Cela nous permet de tester les modifications apportĂ©es Ă  la branche nrcan avant de mettre Ă  jour la branche nrcan_nrc pour nous assurer que +les mesures de ce rĂ©fĂ©rentiel fonctionnent toujours comme prĂ©vu. Les changements ajoutĂ©s Ă  la branche nrcan sont finalement fusionnĂ©s dans la branche master de +openstudio-standards (encore une fois, RNCan effectue des tests importants avant de mettre Ă  jour sa branche et d'y apporter des modifications). + +### Exigences +Nous utilisons tortoise git pour installer la fonctionnalitĂ© git, puis utilisons le shell git bash pour interagir avec ce rĂ©fĂ©rentiel - nous vous recommandons de le faire +le mĂȘme. Nous travaillons Ă©galement sur le systĂšme d'exploitation Windows 10 (nous avons des scripts plus anciens qui fonctionnaient sur Win7 mais ne les maintenons plus). +L'environnement de test et de simulation est construit sur des conteneurs Docker (vous devrez tĂ©lĂ©charger [Docker Desktop](https://www.docker.com/)). Le +les scripts des dossiers testing et server doivent ĂȘtre exĂ©cutĂ©s dans un shell git bash. Ils tĂ©lĂ©chargeront et installeront les conteneurs nĂ©cessaires et +exĂ©cutez les applications nĂ©cessaires - suivez les instructions de chaque dossier pour configurer [exĂ©cuter les tests](test/README.md) ou [le serveur](openstudio-server/README.md). + +### \ No newline at end of file