Create your own Satellite Package

The simplest and most clean way to test your own code in the PalmveinRecLib is to add it in a satellite package. In principle, you can choose a name that fits you, but it is preferable to have a package name that starts with xPalmveinRecLib. to show that it is a satellite package to the PalmveinRecLib. Please refer to the satellite package explanation of Bob, which explains in detail how to start.

Depending on of what nature is your contribution, you have to register it in the setup.py file of your satellite package. In case, your contribution is a palmvein recognition algorithm, you might want to register it. After doing that, you can simply use the bin/palmveinverify.py (or any other script of the PalmveinRecLib) with your registered tool, as if it would be part of the PalmveinRecLib.

Another contribution of code is to provide the source code to rerun the experiments as published in a paper. In this case, the contribution is more about scripts that can be used to run experiments. To cause the buildout system to create a python script in the bin directory, you have to register the script in your setup.py file under the console_scripts section.

Contribute your Code

When you invented a completely new type of preprocessing, features, or recognition algorithm and you want to share them with the world, or you want other researchers to be able to rerun your experiments, you are highly welcome and encouraged to do so. Please make sure that every part of your code is documented and tested.

To upload your satellite package to the world (more specifically to PyPI) you have to create an account and register an ssh key. Add the required packages in the setup.py file and under the install_requires section, provide the other information and upload the package to PyPI via:

$ python setup.py register
$ python setup.py sdist --formats zip upload

Now, all other researchers can make use of your invention, with the effect that your paper will be cited more often, simply by adding your project to the setup.py in their satellite package.