Skip to content

Changes

Page history
Update ESQ Checklists authored by Dennis Terhorst's avatar Dennis Terhorst
Show whitespace changes
Inline Side-by-side
ESQ-Checklists.md
View page @ a522f24a
The [EBRAINS Software Quality](https://gitlab.ebrains.eu/esq-wg/sq-guidelines#software-quality-guidelines) work group created a general [Software Quality Guideline](https://gitlab.ebrains.eu/esq-wg/sq-guidelines/-/jobs/artifacts/main/file/output/SQ-Guideline.pdf?job=build_documents) for EBRAINS related packages. This comes with a [Software Quality Checklist](https://gitlab.ebrains.eu/esq-wg/sq-guidelines/-/jobs/artifacts/main/file/output/SQ-Checklist.pdf?job=build_documents) where package maintainers can declare conformance to established standards.
* :page_with_curl: [Software Quality Guideline](https://gitlab.ebrains.eu/esq-wg/sq-guidelines/-/jobs/artifacts/main/file/output/SQ-Guideline.pdf?job=build_documents)
* :ballot_box_with_check: [Software Quality Checklist](https://gitlab.ebrains.eu/esq-wg/sq-guidelines/-/jobs/artifacts/main/file/output/SQ-Checklist.pdf?job=build_documents) ← :inbox_tray: download this, fill and post in [chat channel](https://chat.ebrains.eu/channel/ebrains-releases) to be added here!
* :busts_in_silhouette: [EBRAINS Software Quality](https://gitlab.ebrains.eu/esq-wg/sq-guidelines#software-quality-guidelines)
| Package | Checklists |
|-|-|
| ***Top Level Packages*** | |
| [`arbor`](../../blob/master/packages/arbor/package.py) | @0.9.0 |
| [`biobb-analysis`](../../blob/master/packages/biobb-analysis/package.py) | @4.0.1 |
| [`biobb-chemistry`](../../blob/master/packages/biobb-chemistry/package.py) | @4.0.0 |
| [`biobb-common`](../../blob/master/packages/biobb-common/package.py) | @4.0.0 |
| [`biobb-gromacs`](../../blob/master/packages/biobb-gromacs/package.py) | @4.0.0 |
| [`biobb-io`](../../blob/master/packages/biobb-io/package.py) | @4.0.0 |
| [`biobb-model`](../../blob/master/packages/biobb-model/package.py) | @4.0.0 |
| [`biobb-structure-checking`](../../blob/master/packages/biobb-structure-checking/package.py) | @3.12.1 |
| [`biobb-structure-utils`](../../blob/master/packages/biobb-structure-utils/package.py) | @4.0.0 |
| [`hxtorch`](../../blob/master/packages/hxtorch/package.py) | @8.0-a5 |
| [`nest`](../../blob/master/packages/nest/package.py) | [@3.7]() |
| [`neuron`](../../blob/master/packages/neuron/package.py) | @8.2.3 |
| [`jaxsnn`](../../blob/master/packages/jaxsnn/package.py) | @8.0-a5 |
| [`py-bluepyefe`](../../blob/master/packages/py-bluepyefe/package.py) | @2.2.18 |
| [`py-bluepymm`](../../blob/master/packages/py-bluepymm/package.py) | @0.7.65 |
| [`py-bluepyopt`](../../blob/master/packages/py-bluepyopt/package.py) | @1.13.86 |
| [`py-bsb`](../../blob/master/packages/py-bsb/package.py) | @4.0.0a57 |
| [`py-ebrains-drive`](../../blob/master/packages/py-ebrains-drive/package.py) | @0.6.0 |
| [`py-ebrains-kg-core`](../../blob/master/packages/py-ebrains-kg-core/package.py) | @0.9.15 |
| [`py-efel`](../../blob/master/packages/py-efel/package.py) | @4.0.4 |
| [`py-elephant`](../../blob/master/packages/py-elephant/package.py) | @1.1.0 |
| [`py-fairgraph`](../../blob/master/packages/py-fairgraph/package.py) | @0.12.0 |
| [`py-frites`](../../blob/master/packages/py-frites/package.py) | @0.4.4 |
| [`py-hbp-archive`](../../blob/master/packages/py-hbp-archive/package.py) | @1.1.1 |
| [`py-hbp-neuromorphic-platform`](../../blob/master/packages/py-hbp-neuromorphic-platform/package.py) | @0.11.2 |
| [`py-hbp-validation-client`](../../blob/master/packages/py-hbp-validation-client/package.py) | @0.8.2 |
| [`py-hippounit`](../../blob/master/packages/py-hippounit/package.py) | @1.3.6 |
| [`py-lfpy`](../../blob/master/packages/py-lfpy/package.py) | @2.3 |
| [`py-lfpykit`](../../blob/master/packages/py-lfpykit/package.py) | @0.5.1 |
| [`py-libneuroml`](../../blob/master/packages/py-libneuroml/package.py) | @0.4.1 |
| [`py-libsonata`](../../blob/master/packages/py-libsonata/package.py) | @0.1.23 |
| [`py-neo`](../../blob/master/packages/py-neo/package.py) | @0.13.0 |
| [`py-nestml`](../../blob/master/packages/py-nestml/package.py) | @7.0.2 |
| [`py-netpyne`](../../blob/master/packages/py-netpyne/package.py) | @1.0.6 |
| [`py-neurom`](../../blob/master/packages/py-neurom/package.py) | @3.2.2 |
| [`py-neuror`](../../blob/master/packages/py-neuror/package.py) | @1.6.4 |
| [`py-pynn`](../../blob/master/packages/py-pynn/package.py) | @0.12.3 |
| [`py-pyunicore`](../../blob/master/packages/py-pyunicore/package.py) | @1.0.1 |
| [`py-quantities-scidash`](../../blob/master/packages/py-quantities-scidash/package.py) | @0.12.4.3 |
| [`py-quantities`](../../blob/master/packages/py-quantities/package.py) | @0.15.0 |
| [`py-siibra`](../../blob/master/packages/py-siibra/package.py) | @1.0a9 |
| [`py-snudda`](../../blob/master/packages/py-snudda/package.py) | @2.0.1 |
| [`py-spynnaker`](../../blob/master/packages/py-spynnaker/package.py) | @7.0.0 |
| [`py-tvb-contrib`](../../blob/master/packages/py-tvb-contrib/package.py) | @2.9 |
| [`py-tvb-data`](../../blob/master/packages/py-tvb-data/package.py) | @2.8 |
| [`py-tvb-framework`](../../blob/master/packages/py-tvb-framework/package.py) | @2.9 |
| [`py-tvb-gdist`](../../blob/master/packages/py-tvb-gdist/package.py) | @2.2 |
| [`py-tvb-library`](../../blob/master/packages/py-tvb-library/package.py) | @2.9 |
| [`py-tvb-multiscale`](../../blob/master/packages/py-tvb-multiscale/package.py) | @2.1.0.ebrains |
| [`py-tvb-storage`](../../blob/master/packages/py-tvb-storage/package.py) | @2.9 |
| [`py-tvb-widgets`](../../blob/master/packages/py-tvb-widgets/package.py) | @2.0.3 |
| [`py-viziphant`](../../blob/master/packages/py-viziphant/package.py) | @0.4.0 |
| [`pynn-brainscales`](../../blob/master/packages/pynn-brainscales/package.py) | @8.0-a5 |
| [`r-rgsl`](../../blob/master/packages/r-rgsl/package.py) | @0.1.1 |
| [`r-sbtabvfgen`](../../blob/master/packages/r-sbtabvfgen/package.py) | @0.1 |
| [`r-uqsa`](../../blob/master/packages/r-uqsa/package.py) | @2.2 |
| [`sda`](../../blob/master/packages/sda/package.py) | @7.3.3d |
| [`arbor`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/arbor/package.py) | @0.9.0 |
| [`biobb-analysis`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-analysis/package.py) | @4.0.1 |
| [`biobb-chemistry`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-chemistry/package.py) | @4.0.0 |
| [`biobb-common`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-common/package.py) | @4.0.0 |
| [`biobb-gromacs`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-gromacs/package.py) | @4.0.0 |
| [`biobb-io`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-io/package.py) | @4.0.0 |
| [`biobb-model`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-model/package.py) | @4.0.0 |
| [`biobb-structure-checking`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-structure-checking/package.py) | @3.12.1 |
| [`biobb-structure-utils`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/biobb-structure-utils/package.py) | @4.0.0 |
| [`hxtorch`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/hxtorch/package.py) | @8.0-a5 |
| [`nest`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/nest/package.py) | [@3.7]() |
| [`neuron`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/neuron/package.py) | @8.2.3 |
| [`jaxsnn`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/jaxsnn/package.py) | @8.0-a5 |
| [`py-bluepyefe`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-bluepyefe/package.py) | @2.2.18 |
| [`py-bluepymm`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-bluepymm/package.py) | @0.7.65 |
| [`py-bluepyopt`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-bluepyopt/package.py) | @1.13.86 |
| [`py-bsb`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-bsb/package.py) | @4.0.0a57 |
| [`py-ebrains-drive`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-ebrains-drive/package.py) | @0.6.0 |
| [`py-ebrains-kg-core`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-ebrains-kg-core/package.py) | @0.9.15 |
| [`py-efel`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-efel/package.py) | @4.0.4 |
| [`py-elephant`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-elephant/package.py) | @1.1.0 |
| [`py-fairgraph`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-fairgraph/package.py) | @0.12.0 |
| [`py-frites`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-frites/package.py) | @0.4.4 |
| [`py-hbp-archive`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-hbp-archive/package.py) | @1.1.1 |
| [`py-hbp-neuromorphic-platform`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-hbp-neuromorphic-platform/package.py) | @0.11.2 |
| [`py-hbp-validation-client`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-hbp-validation-client/package.py) | @0.8.2 |
| [`py-hippounit`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-hippounit/package.py) | @1.3.6 |
| [`py-lfpy`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-lfpy/package.py) | @2.3 |
| [`py-lfpykit`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-lfpykit/package.py) | @0.5.1 |
| [`py-libneuroml`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-libneuroml/package.py) | @0.4.1 |
| [`py-libsonata`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-libsonata/package.py) | @0.1.23 |
| [`py-neo`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-neo/package.py) | @0.13.0 |
| [`py-nestml`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-nestml/package.py) | @7.0.2 |
| [`py-netpyne`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-netpyne/package.py) | @1.0.6 |
| [`py-neurom`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-neurom/package.py) | @3.2.2 |
| [`py-neuror`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-neuror/package.py) | @1.6.4 |
| [`py-pynn`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-pynn/package.py) | @0.12.3 |
| [`py-pyunicore`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-pyunicore/package.py) | @1.0.1 |
| [`py-quantities-scidash`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-quantities-scidash/package.py) | @0.12.4.3 |
| [`py-quantities`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-quantities/package.py) | @0.15.0 |
| [`py-siibra`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-siibra/package.py) | @1.0a9 |
| [`py-snudda`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-snudda/package.py) | @2.0.1 |
| [`py-spynnaker`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-spynnaker/package.py) | @7.0.0 |
| [`py-tvb-contrib`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-contrib/package.py) | @2.9 |
| [`py-tvb-data`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-data/package.py) | @2.8 |
| [`py-tvb-framework`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-framework/package.py) | @2.9 |
| [`py-tvb-gdist`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-gdist/package.py) | @2.2 |
| [`py-tvb-library`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-library/package.py) | @2.9 |
| [`py-tvb-multiscale`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-multiscale/package.py) | @2.1.0.ebrains |
| [`py-tvb-storage`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-storage/package.py) | @2.9 |
| [`py-tvb-widgets`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-tvb-widgets/package.py) | @2.0.3 |
| [`py-viziphant`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-viziphant/package.py) | @0.4.0 |
| [`pynn-brainscales`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/pynn-brainscales/package.py) | @8.0-a5 |
| [`r-rgsl`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/r-rgsl/package.py) | @0.1.1 |
| [`r-sbtabvfgen`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/r-sbtabvfgen/package.py) | @0.1 |
| [`r-uqsa`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/r-uqsa/package.py) | @2.2 |
| [`sda`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/sda/package.py) | @7.3.3d |
| ***Workflows (meta-packages)*** | |
| [`wf-biobb`](../../blob/master/packages/wf-biobb/package.py) | :warning: |
| [`wf-brainscales2-demos`](../../blob/master/packages/wf-brainscales2-demos/package.py) | @8.0-a5 |
| [`wf-protein-association-rates`](../../blob/master/packages/wf-protein-association-rates/package.py) | @0.1 |
| [`wf-multi-area-model`](../../blob/master/packages/wf-multi-area-model/package.py) | @1.2.0 |
| [`wf-uq-akar4`](../../blob/master/packages/wf-uq-akar4/package.py) | @0.1 |
| [`wf-custom-python`](../../blob/master/packages/wf-custom-python/package.py) | @0.1 |
| [`wf-biobb`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/wf-biobb/package.py) | :warning: |
| [`wf-brainscales2-demos`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/wf-brainscales2-demos/package.py) | @8.0-a5 |
| [`wf-protein-association-rates`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/wf-protein-association-rates/package.py) | @0.1 |
| [`wf-multi-area-model`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/wf-multi-area-model/package.py) | @1.2.0 |
| [`wf-uq-akar4`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/wf-uq-akar4/package.py) | @0.1 |
| [`wf-custom-python`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/wf-custom-python/package.py) | @0.1 |
| ***DRAFT*** | |
| [`py-cerebstats`](../../blob/master/packages/py-cerebstats/package.py) | – |
| [`py-cerebunit`](../../blob/master/packages/py-cerebunit/package.py) | – |
| [`py-morphounit`](../../blob/master/packages/py-morphounit/package.py) | @1.0.4 |
| [`py-cerebstats`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-cerebstats/package.py) | – |
| [`py-cerebunit`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-cerebunit/package.py) | – |
| [`py-morphounit`](https://gitlab.ebrains.eu/ri/tech-hub/platform/esd/ebrains-spack-builds/-/blob/master//packages/py-morphounit/package.py) | @1.0.4 |
\ No newline at end of file