pydra-tasks-fastsurfer


Namepydra-tasks-fastsurfer JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryPydra tasks package for fastsurfer
upload_time2025-08-25 01:06:35
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseCopyright 2021 Nipype developers Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
keywords pydra
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pydra task package for fastsurfer

[![CI/CD](https://github.com/nipype/pydra-fastsurfer/actions/workflows/ci-cd.yaml/badge.svg)](https://github.com/nipype/pydra-fastsurfer/actions/workflows/ci-cd.yaml)
[![Codecov](https://codecov.io/gh/nipype/pydra-fastsurfer/branch/main/graph/badge.svg?token=UIS0OGPST7)](https://codecov.io/gh/nipype/pydra-fastsurfer)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/pydra-fastsurfer.svg)](https://pypi.python.org/pypi/pydra-fastsurfer/)
[![Latest Version](https://img.shields.io/pypi/v/pydra-fastsurfer.svg)](https://pypi.python.org/pypi/pydra-fastsurfer/)

This package contains a Pydra interface for the fastsurfer toolkit.t.


## Tests

This package comes with a battery of automatically generated test modules. To install the necessary dependencies to run the tests, use the following command:

the necessary dependencies to run the tests

```
   $ pip install -e .[test]
```

Then the tests, including [doctests](https://docs.python.org/3/library/doctest.html), can be launched using

```
   $ pytest --doctest-modules pydra/tasks/*
```


By default, the tests are set to time-out after 10s, after which the underlying tool is
assumed to have passed the validation/initialisation phase and we assume that it will
run to completion. To disable this and run the test(s) through to completion run

```
   $ pytest --doctest-modules --timeout-pass 0 pydra/tasks/*
```


## Contributing to this package

### Developer installation

Install repo in developer mode from the source directory and install pre-commit to
ensure consistent code-style and quality.

```
   $ pip install -e .[test,dev]
   $ pre-commit install
```


### Typing and sample test data

The automatically generated tests will attempt to provided the task instance to be tested
with sensible default values based on the type of the field and any constraints it has
on it. However, these will often need to be manually overridden after consulting the
underlying tool's documentation.

For file-based data, automatically generated file-system objects will be created for
selected format types, e.g. Nifti, Dicom. Therefore, it is important to specify the
format of the file using the "mime-like" string corresponding to a
[fileformats](https://github.com/ArcanaFramework/fileformats) class
in the ``inputs > types`` and ``outputs > types`` dicts of the YAML spec.

If the required file-type is not found implemented within fileformats, please see the [fileformats
docs](https://arcanaframework.github.io/fileformats/developer.html) for instructions on how to define
new fileformat types, and see 
[fileformats-medimage-extras](https://github.com/ArcanaFramework/fileformats-medimage-extras/blob/6c2dabe91e95687eebc2639bb6f034cf9595ecfc/fileformats/extras/medimage/nifti.py#L30-L48)
for an example on how to implement methods to generate sample data for them.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pydra-tasks-fastsurfer",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Nipype developers <neuroimaging@python.org>",
    "keywords": "pydra",
    "author": null,
    "author_email": "Nipype developers <neuroimaging@python.org>",
    "download_url": "https://files.pythonhosted.org/packages/ab/b6/d95c3b554840c2ffbceb35af7ab4de7d9ce2cd94686fa465e7a2b4d6628e/pydra_tasks_fastsurfer-0.2.0.tar.gz",
    "platform": null,
    "description": "# Pydra task package for fastsurfer\n\n[![CI/CD](https://github.com/nipype/pydra-fastsurfer/actions/workflows/ci-cd.yaml/badge.svg)](https://github.com/nipype/pydra-fastsurfer/actions/workflows/ci-cd.yaml)\n[![Codecov](https://codecov.io/gh/nipype/pydra-fastsurfer/branch/main/graph/badge.svg?token=UIS0OGPST7)](https://codecov.io/gh/nipype/pydra-fastsurfer)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/pydra-fastsurfer.svg)](https://pypi.python.org/pypi/pydra-fastsurfer/)\n[![Latest Version](https://img.shields.io/pypi/v/pydra-fastsurfer.svg)](https://pypi.python.org/pypi/pydra-fastsurfer/)\n\nThis package contains a Pydra interface for the fastsurfer toolkit.t.\n\n\n## Tests\n\nThis package comes with a battery of automatically generated test modules. To install the necessary dependencies to run the tests, use the following command:\n\nthe necessary dependencies to run the tests\n\n```\n   $ pip install -e .[test]\n```\n\nThen the tests, including [doctests](https://docs.python.org/3/library/doctest.html), can be launched using\n\n```\n   $ pytest --doctest-modules pydra/tasks/*\n```\n\n\nBy default, the tests are set to time-out after 10s, after which the underlying tool is\nassumed to have passed the validation/initialisation phase and we assume that it will\nrun to completion. To disable this and run the test(s) through to completion run\n\n```\n   $ pytest --doctest-modules --timeout-pass 0 pydra/tasks/*\n```\n\n\n## Contributing to this package\n\n### Developer installation\n\nInstall repo in developer mode from the source directory and install pre-commit to\nensure consistent code-style and quality.\n\n```\n   $ pip install -e .[test,dev]\n   $ pre-commit install\n```\n\n\n### Typing and sample test data\n\nThe automatically generated tests will attempt to provided the task instance to be tested\nwith sensible default values based on the type of the field and any constraints it has\non it. However, these will often need to be manually overridden after consulting the\nunderlying tool's documentation.\n\nFor file-based data, automatically generated file-system objects will be created for\nselected format types, e.g. Nifti, Dicom. Therefore, it is important to specify the\nformat of the file using the \"mime-like\" string corresponding to a\n[fileformats](https://github.com/ArcanaFramework/fileformats) class\nin the ``inputs > types`` and ``outputs > types`` dicts of the YAML spec.\n\nIf the required file-type is not found implemented within fileformats, please see the [fileformats\ndocs](https://arcanaframework.github.io/fileformats/developer.html) for instructions on how to define\nnew fileformat types, and see \n[fileformats-medimage-extras](https://github.com/ArcanaFramework/fileformats-medimage-extras/blob/6c2dabe91e95687eebc2639bb6f034cf9595ecfc/fileformats/extras/medimage/nifti.py#L30-L48)\nfor an example on how to implement methods to generate sample data for them.\n",
    "bugtrack_url": null,
    "license": "Copyright 2021 Nipype developers\n        \n           Licensed under the Apache License, Version 2.0 (the \"License\");\n           you may not use this file except in compliance with the License.\n           You may obtain a copy of the License at\n        \n               http://www.apache.org/licenses/LICENSE-2.0\n        \n           Unless required by applicable law or agreed to in writing, software\n           distributed under the License is distributed on an \"AS IS\" BASIS,\n           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n           See the License for the specific language governing permissions and\n           limitations under the License.",
    "summary": "Pydra tasks package for fastsurfer",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [
        "pydra"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cc740f4ed1ea2bee7dfb7330acbd3c0e75ea5148ff3b8d72120bcec3e08eeaeb",
                "md5": "d839fedaa30c1635e146bf9d94e9fe8b",
                "sha256": "e44ea54a3800bd4ce36ce780c82a10ead87016582d29bf6c4bd6db206fc6553f"
            },
            "downloads": -1,
            "filename": "pydra_tasks_fastsurfer-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d839fedaa30c1635e146bf9d94e9fe8b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 7763,
            "upload_time": "2025-08-25T01:06:33",
            "upload_time_iso_8601": "2025-08-25T01:06:33.771193Z",
            "url": "https://files.pythonhosted.org/packages/cc/74/0f4ed1ea2bee7dfb7330acbd3c0e75ea5148ff3b8d72120bcec3e08eeaeb/pydra_tasks_fastsurfer-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "abb6d95c3b554840c2ffbceb35af7ab4de7d9ce2cd94686fa465e7a2b4d6628e",
                "md5": "428220fa81bf7c5e1da12aba08210292",
                "sha256": "0040db5533f2b60dc3e9a7f5505fdc409fe7227384d234655b35835b10070efc"
            },
            "downloads": -1,
            "filename": "pydra_tasks_fastsurfer-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "428220fa81bf7c5e1da12aba08210292",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 10261,
            "upload_time": "2025-08-25T01:06:35",
            "upload_time_iso_8601": "2025-08-25T01:06:35.488168Z",
            "url": "https://files.pythonhosted.org/packages/ab/b6/d95c3b554840c2ffbceb35af7ab4de7d9ce2cd94686fa465e7a2b4d6628e/pydra_tasks_fastsurfer-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-25 01:06:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pydra-tasks-fastsurfer"
}
        
Elapsed time: 1.37283s