Python库 | bids-validator-1.8.5.dev0.tar.gz

[](https://circleci.com/gh/bids-standard/bids-validator) [](https://gitlab.com/bids-standard/bids-validator/pipelines) [](https://codecov.io/gh/bids-standard/bids-validator) [](https://doi.org/10.5281/zenodo.3688707) # BIDS-Validator - [BIDS-Validator](#bids-validator) - [Quickstart](#quickstart) - [Support](#support) - [Maintainers and Contributors](#maintainers-and-contributors) - [Use](#use) - [API](#api) - [.bidsignore](#bidsignore) - [Configuration](#configuration) - [In the Browser](#in-the-browser) - [On the Server](#on-the-server) - [Through Command Line](#through-command-line) - [Docker image](#docker-image) - [Python Library](#python-library) - [Example](#example) - [Development](#development) - [Running Locally in a Browser](#running-locally-in-a-browser) - [Testing](#testing) - [Publishing](#publishing) - [Acknowledgments](#acknowledgments) ## Quickstart 1. Web version: 1. Open [Google Chrome](https://www.google.com/chrome/) or [Mozilla Firefox](https://mozilla.org/firefox) (currently the only supported browsers) 1. Go to http://bids-standard.github.io/bids-validator/ and select a folder with your BIDS dataset. If the validator seems to be working longer than couple of minutes please open [developer tools ](https://developer.chrome.com/devtools) and report the error at [https://github.com/bids-standard/bids-validator/issues](https://github.com/bids-standard/bids-validator/issues). 1. Command line version: 1. Install [Node.js](https://nodejs.org) (at least version 10.11.0) 1. Update `npm` to be at least version 7 (`npm install --global npm@^7`) 1. From a terminal run `npm install -g bids-validator` 1. Run `bids-validator` to start validating datasets. 1. Docker 1. Install Docker 1. From a terminal run `docker run -ti --rm -v /path/to/data:/data:ro bids/validator /data` but replace the `/path/to/data` part of the command with your own path on your machine. 1. Python Library: 1. Install [Python](https://www.python.org/) 1. Install [Pip](https://pip.pypa.io/en/stable/installing/) package manager for Python, if not already installed. 1. From a terminal run `pip install bids_validator` to acquire the [BIDS Validator PyPi package](https://pypi.org/project/bids-validator/) 1. Open a Python terminal and type: `python` 1. Import the BIDS Validator package `from bids_validator import BIDSValidator` 1. Check if a file is BIDS compatible `BIDSValidator().is_bids('path/to/a/bids/file')` ## Support The BIDS Validator is designed to work in both the browser and in Node.js. We target support for the latest long term stable (LTS) release of Node.js and the latest version of Chrome. There is also a library of helper functions written in Python, for use with BIDS compliant applications written in this language. Please report any issues you experience while using these support targets via the [GitHub issue tracker](https://github.com/bids-standard/bids-validator/issues). If you experience issues outside of these supported environments and believe we should extend our targeted support feel free to open a new issue describing the issue, your support target and why you require extended support and we will address these issues on a case by case basis. ## Maintainers and Contributors <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> [](#contributors-) <!-- ALL-CONTRIBUTORS-BADGE:END --> This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! The project is maintained by [@rwblair](https://github.com/rwblair/) with the help of many contributors listed below. (The [emoji key](https://allcontributors.org/docs/en/emoji-key) is indicating the kind of contribution) Please also see [Acknowledgments](#acknowledgments). <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://adam2392.github.io/"><img src="https://avatars.githubusercontent.com/u/3460267?v=4?s=50" width="50px;" alt=""/><br />_{<b>Adam Li</b>}</a><br /><a href="https://github.com/bids-standard/bids-validator/commits?author=adam2392" title="Code">💻</a> <a href="https://github.com/bids-standard/bids-validator/commits?author=adam2392" title="Tests">⚠️</a> <a href="#userTesting-adam2392" title="User Testing">📓</a> <a href="https://github.com/bids-standard/bids-validator/issues?q=author%3Aadam2392" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/agt24"><img src="https://avatars.githubusercontent.com/u/7869017?v=4?s=50" width="50px;" alt=""/><br />_{<b>Adam Thomas</b>}</a><br /><a href="https://github.com/bids-standard/bids-validator/commits?author=agt24" title="Documentation">📖</a></td> <td align="center"><a href="http://happy5214.freedynamicdns.org/"><img src="https://avatars.githubusercontent.com/u/2992751?v=4?s=50" width="50px;" alt=""/><br />_{<b>Alexander Jones</b>}</a><br /><a href="https://github.com/bids-standard/bids-validator/commits?author=happy5214" title="Code">💻</a> <a href="https://github.com/bids-standard/bids-validator/commits?author=happy5214" title="Tests">⚠️</a> <a href="#ideas-happy5214" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="http://chrisgorgolewski.org"><img src="https://avatars.githubusercontent.com/u/238759?v=4?s=50" width="50px;" alt=""/><br />_{<b>Chris Gorgolewski</b>}</a><br /><a href="https://github.com/bids-standard/bids-validator/issues?q=author%3Achrisgorgo" title="Bug reports">🐛</a> <a href="https://github.com/bids-standard/bids-validator/commits?author=chrisgorgo" title="Code">💻</a> <a href="#data-chrisgorgo" title="Data">🔣</a> <a href="https://github.com/bids-standard/bids-validator/commits?author=chrisgorgo" title="Documentation">📖</a> <a href="#example-chrisgorgo" title="Examples">💡</a> <a href="#ideas-chrisgorgo" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-chrisgorgo" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-chrisgorgo" title="Maintenance">🚧</a> <a href="#mentoring-chrisgorgo" title="Mentoring">🧑‍🏫</a> <a href="#question-chrisgorgo" title="Answering Questions">💬</a> <a href="https://github.com/bids-standard/bids-validator/pulls?q=is%3Apr+reviewed-by%3Achrisgorgo" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/bids-standard/bids-validator/commits?author=chrisgorgo" title="Tests">⚠️</a> <a href="#tutorial-chrisgorgo" title="Tutorials">✅</a> <a href="#talk-chrisgorgo" title="Talks">📢</a> <a href="#userTesting-chrisgorgo" title="User Testing">📓</a></td> <td align="center"><a href="https://github.com/choldgraf"><img src="https://avatars.githubusercontent.com/u/1839645?v=4?s=50" width="50px;" alt=""/><br />_{<b>Chris Holdgraf</b>}</a><br /><a href="https://github.com/bids-standard/bids-validator/commits?author=choldgraf" title="Code">💻</a></td> <td align="center"><a href="https://github.com/effigies"><img src="https://avatars.githubusercontent.com/u/83442?v=4?s=50" width="50px;" alt=""/><br />_{<b>Chris Markiewicz</b>}</a><br /><a href="https://github.com/bids-standard/bids-validator/commits?author=effigies" title="Code">💻</a> <a