Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/alleninstitute/np_config

Config fetching from file or Zookeeper - with local backup - repackaging code from AIBS mpeconfig.

https://github.com/alleninstitute/np_config

Science Score: 23.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
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (5.8%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

Config fetching from file or Zookeeper - with local backup - repackaging code from AIBS mpeconfig.

Basic Info
  • Host: GitHub
  • Owner: AllenInstitute
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 121 KB
Statistics
  • Stars: 0
  • Watchers: 7
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Created over 3 years ago · Last pushed about 2 years ago
Metadata Files
Readme

README.md

np_config

For use on internal Allen Institute network

Usage

Fetch configs from ZooKeeper nodes or .yaml/.json files:

```python import np_config

zkconfig: dict[str, str | int] = npconfig.from_zk('/rigs/NP.1')

fileconfig: dict[str, Any] = npconfig.fromfile('localconfig.yaml')

```

If running on a machine attached to a Mindscope Neuropixels rig (NP.0, ..., NP.3), get rig-specific config info with:

```python rig = np_config.Rig()

name: str = rig.id # "NP.1" index: int = rig.idx # 1

acquisitionpchostname: str = rig.acq # "W10DT713843" config: dict[str, str | int] = rig.config # specific to NP.1 paths: dict[str, pathlib.Path] = rig.paths # using values from rig.config ```

If not running on a rig-attached machine, get the config for a particular rig by supplying rig-index as an int to Rig:

```python np1 = np_config.Rig(1)

np1mvrdata_root: pathlib.Path = np.paths['MVR'] ```

Development

Initialize for local development

bash poetry install --with dev

Run the tests

bash poetry run pytest

Owner

  • Name: Allen Institute
  • Login: AllenInstitute
  • Kind: organization
  • Location: Seattle, WA

Please visit http://alleninstitute.github.io/ for more information.

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 58
  • Total Committers: 2
  • Avg Commits per committer: 29.0
  • Development Distribution Score (DDS): 0.241
Top Committers
Name Email Commits
bjhardcastle b****e@a****g 44
Ben Hardcastle 6****e@u****m 14
Committer Domains (Top 20 + Academic)
alleninstitute.org: 1

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 4
  • Total pull requests: 3
  • Average time to close issues: 1 day
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 1 day
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mochic (3)
  • mekhlakapoor (1)
Pull Request Authors
  • mochic (5)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 349 last-month
  • Total dependent packages: 8
  • Total dependent repositories: 1
  • Total versions: 44
  • Total maintainers: 1
pypi.org: np-config

Config fetching from file or Zookeeper - with local backup - repackaging code from AIBS mpeconfig.

  • Versions: 44
  • Dependent Packages: 8
  • Dependent Repositories: 1
  • Downloads: 349 Last month
Rankings
Dependent packages count: 1.4%
Downloads: 15.9%
Average: 21.5%
Dependent repos count: 21.6%
Forks count: 29.8%
Stargazers count: 38.8%
Maintainers (1)
bjhardcastle
Last synced: 11 months ago

Dependencies

pyproject.toml pypi
  • appdirs ^1
  • backports.cached-property *
  • kazoo ~2.8
  • python ^3.7
  • pyyaml >= 5, <7
  • requests ^2
  • typing-extensions >= 4