Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 3.1 KB

README.md

File metadata and controls

61 lines (44 loc) · 3.1 KB
Raw

VMTK-Test-Data

Build Status Build status

The Vascular Modeling Toolkit is an open source project where people from all over the world can contribute their work, with everyone benefitting from friendly help and advice, and kindly helping others in return. This is the test data repository for the main project. If you are looking for VMTK proper, head on over to the VMTK Github Repository or the VMTK Webpage.

How to help?

Contributing to vmtk

If you want to contribute to vmtk please fork the source code

See github collaborating guide, and feel free to reach out to us on the mailing list or the issue tracker for any questions.

For contributing instructions, check out the VMTK Contributing Guide

Testing

Aquiring Test Data

VMTK utilizes a git submodule in order to orchestrate the aquisition of large binary data files. If you have just simply cloned the vmtk repository, you will find the tests data director (tests/vmtk-test-data) empty.

Setting the CMake variable VMTK_BUILD_TESTING=ON and building the project will use this information to download the actual binary files to this directory in the build tree. It will also automatically configure the paths to this data directory referenced in the tests directory.

Running Tests

We use the pytest testing framework for unit testing. After building the library, run pytest ./ from within the Install/tests directory.

Contributing Tests

In order to contribute tests, can clone the vmtk-test-data repository at the same level as vmtk. Please add any test data files in the appropriate folders in the vmtk-test-data repository. if you create new test files within the tests/test_FOO directory, be sure to add that file to the accompanying CMakeLists.txt file as well. When your tests run locally, your data assets and test changes should be reflected and all tests should appear to pass.

If you are contributing tests which require new data files, create a PR to the vmtk-test-data repository and let us know the PR# in VMTK which the data files corresponds to. Until we merge the data, our CI suite will not have access to files, so your tests that passed locally may appear to fail when they are pushed - Don't worry! It's not you, it's our system!

Questions? Concerns? If you have any questions about the contributing

process, or just want to learn more about the library, feel free to reach out to us on the mailing list or the issue tracker. We'd love to chat!