Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: FZJ-INM1-BDA
  • License: apache-2.0
  • Language: Python
  • Default Branch: master
  • Size: 1.22 MB
Statistics
  • Stars: 4
  • Watchers: 3
  • Forks: 3
  • Open Issues: 5
  • Releases: 245
Created about 5 years ago · Last pushed 9 months ago
Metadata Files
Readme License Codemeta

README.md

siibra - API

Copyright 2020-2021, Forschungszentrum Jülich GmbH

Authors: Big Data Analytics Group, Institute of Neuroscience and Medicine (INM-1), Forschungszentrum Jülich GmbH

License

:warning: siibra-api is still at an experimental stage. The API of the library is not stable, and the software is not yet fully tested. You are welcome to install and test it, but be aware that you will likely encounter bugs.

Overview

Siibra-API provides an easy REST access to the siibra-python features.

The main goal is to abstract the python functionalities in a way that they can be used via HTTP and make it more independent and accessible.

Documentation

All of the public endpoints provided by siibra-api are documented by openapi, see swagger redoc.

Development documentations can be found on readthedocs .

Configuration

siibra-api can be configured by:

  • environment variables, as indicated by the ./api/siibra_api_config.py , or ...
  • directly overwriting the ./api/siibra_api_config.py file, by overwriting or docker volume mounting

How to contribute

If you want to contribute to siibra-api, feel free to fork it and open a pull request with your changes. You are also welcome to contribute to discussion in the issue tracker and of course to report issues you are facing yourself. If you find the software useful, please reference this repository URL in publications and derived work. You can also star the project to show us that you are using it.

Acknowledgements

This software code is funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).

Owner

  • Name: Big Data Analytics group
  • Login: FZJ-INM1-BDA
  • Kind: organization
  • Location: Jülich, Germany

Big Data Analytics group at the Institute of Neuroscience and Medicine (INM-1), Forschungszentrum Juelich

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "type": "SoftwareSourceCode",
  "author": [
    {
      "id": "_:author_1",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Forschungszentrum Juelich"
      },
      "email": "x.gui@fz-juelich.de",
      "familyName": "Gui",
      "givenName": "Xiaoyun"
    },
    {
      "id": "_:author_2",
      "type": "Person",
      "familyName": "Marcenko",
      "givenName": "Vadim"
    },
    {
      "id": "_:author_3",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Forschungszentrum Juelich"
      },
      "email": "ah.simsek@fz-juelich.de",
      "familyName": "Simsek",
      "givenName": "Ahmet Nihat"
    },
    {
      "id": "https://orcid.org/0000-0002-9051-3701",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Forschungszentrum Juelich"
      },
      "email": "t.dickscheid@fz-juelich.de",
      "familyName": "Dickscheid",
      "givenName": "Timo"
    }
  ],
  "codeRepository": "git+https://github.com/fzj-inm1-bda/siibra-api.git",
  "dateCreated": "2024-08-28",
  "dateModified": "2024-08-28",
  "datePublished": "2021-07-18",
  "description": "Siibra-API provides an easy REST access to the siibra-python features.\n\n The main goal is to abstract the python functionalities in a way that they can be used via HTTP and make it more independent and accessible.",
  "license": "https://spdx.org/licenses/Apache-2.0",
  "name": "siibra-api",
  "programmingLanguage": [
    "python 3"
  ],
  "runtimePlatform": "docker",
  "version": "0.3.28",
  "contIntegration": "https://github.com/FZJ-INM1-BDA/siibra-api/actions",
  "codemeta:continuousIntegration": {
    "id": "https://github.com/FZJ-INM1-BDA/siibra-api/actions"
  },
  "issueTracker": "https://github.com/fzj-inm1-bda/siibra-api/issues"
}

GitHub Events

Total
  • Create event: 50
  • Issues event: 1
  • Release event: 47
  • Issue comment event: 1
  • Push event: 57
Last Year
  • Create event: 50
  • Issues event: 1
  • Release event: 47
  • Issue comment event: 1
  • Push event: 57

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 785
  • Total Committers: 4
  • Avg Commits per committer: 196.25
  • Development Distribution Score (DDS): 0.38
Past Year
  • Commits: 110
  • Committers: 1
  • Avg Commits per committer: 110.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Xiao Gui x****3@g****m 487
Vadim v****o@g****e 234
vadim v****o@f****e 62
Ahmet Nihat Simsek 6****k 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 23
  • Total pull requests: 77
  • Average time to close issues: 8 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 6
  • Total pull request authors: 2
  • Average comments per issue: 2.22
  • Average comments per pull request: 0.31
  • Merged pull requests: 70
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • marcenko (10)
  • xgui3783 (7)
  • valentin-pinkau (3)
  • dickscheid (3)
  • fsdavid (1)
  • KimLothmann (1)
Pull Request Authors
  • xgui3783 (71)
  • marcenko (7)
Top Labels
Issue Labels
bug (1) enhancement (1)
Pull Request Labels

Dependencies

Dockerfile docker
  • python 3.10 build
.github/workflows/docker-img.yml actions
  • actions/checkout v2 composite
.github/workflows/github-actions.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
docker-compose-dev.yml docker
  • redis latest
  • siibra-api v0.4-all
docker-compose-sw.yml docker
  • redis latest
  • siibra-api v0.4-server
  • siibra-api v0.4-worker
docker-compose.yml docker
  • redis latest
  • siibra-api v0.4-all
requirements/all.txt pypi
  • diskcache *
  • fastapi *
  • fastapi-pagination *
  • fastapi-versioning *
  • jinja2 *
  • redis *
  • requests *
  • uvicorn *
requirements/docs.txt pypi
  • mdx_truly_sane_lists *
  • mkdocs >=1.1,<2
  • mkdocs-material *
requirements/server.txt pypi
  • celery ==5.2.6
  • diskcache *
  • fastapi *
  • fastapi-pagination *
  • fastapi-versioning *
  • jinja2 *
  • redis *
  • requests *
  • uvicorn *
requirements/siibra.txt pypi
  • siibra >=0.4a29
requirements/worker.txt pypi
  • celery ==5.2.6
  • pydantic *
.github/workflows/deploy-on-okd.yml actions
.github/workflows/ebrains_sync.yml actions
  • actions/checkout v3 composite
  • wei/git-sync v3 composite
requirements/partial-all.txt pypi
  • diskcache *
  • fastapi *
  • fastapi-pagination *
  • fastapi-versioning *
  • jinja2 *
  • pydantic <2
  • redis *
  • requests *
  • uvicorn *
requirements/partial-worker.txt pypi
  • celery ==5.2.6
  • pydantic <2