Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/fix/not_enforce_longitudinal' in…
Browse files Browse the repository at this point in the history
…to fix/not_enforce_longitudinal
  • Loading branch information
tientong98 committed Jan 17, 2025
2 parents 1dcde70 + 967fde1 commit fcccf98
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"sphinx_gallery.load_style",
"sphinxarg.ext", # argparse extension
"sphinxcontrib.bibtex", # bibtex-based bibliographies
"sphinx_design", # for adding in-line badges etc
]

# Mock modules in autodoc:
Expand Down
13 changes: 10 additions & 3 deletions docs/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,6 @@ Since we ran ``cubids add-nifti-info`` with the ``--use-datalad`` flag set,
BIDS validation
---------------

The next step in the ``CuBIDS`` workflow is to run BIDS validation
to detect potential curation errors using ``cubids validate``.

.. code-block:: console
$ cubids validate BIDS_Dataset_DataLad v0 --sequential
Expand All @@ -187,6 +184,16 @@ to detect potential curation errors using ``cubids validate``.
This can be helpful for identifying heterogeneous elements,
but can be slowed down by extremely large datasets.

.. warning::
For internetless use cases, please see dedicated section of the `Installation page
<https://cubids.readthedocs.io/en/latest/installation.html>`_ on how to download a local version
of the validator.

After that, you will need to add ``--local-validator`` option to the command string above.

The next step in the ``CuBIDS`` workflow is to run BIDS validation
to detect potential curation errors using ``cubids validate``.

This command produces the following tsv:

.. csv-table:: v0_validation.tsv
Expand Down
20 changes: 20 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,26 @@ We can accomplish this using the following command:
The new schema-based ``bids-validator`` doesn't need to be installed
and will be implemented automatically when `cubids validate` is called

.. dropdown:: If there is no Internet connection on compute nodes

If your HPC doesn't allow internet access on its compute nodes, it won't be able to run the online
version of the BIDS validator. In that scenario, you need to install the BIDS validator on your HPC
and then point to the installed version in your cubids validate calls.
To do that, you should run one of these commands below, after installing deno, that downloads the latest version
of the bids-validator in your virtual environment either by installing a lightscript version
(into ``$HOME/.deno/bin``) or by compiling, respectively:

.. code-block:: console
$ deno install -ERN -g -n bids-validator jsr:@bids/validator
or:

.. code-block:: console
$ deno compile -ERN -o bids-validator jsr:@bids/validator
For more information, you can read: https://bids-validator.readthedocs.io/en/latest/user_guide/command-line.html

We also recommend using ``CuBIDS`` with the optional ``DataLad`` version control capabilities.
We use ``DataLad`` throughout our walkthrough of the CuBIDS Workflow on
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ doc = [
"sphinx_markdown_tables",
"sphinx_rtd_theme",
"sphinxcontrib-bibtex",
"sphinx_design",
]
tests = [
"codespell",
Expand Down

0 comments on commit fcccf98

Please sign in to comment.