Skip to content

🌳 Installation

To install the required packages in a virtual environment, run the following command:

From PyPi

The easiest is to pip-install the package:

pip install woodtapper

From Source

Otherwise you can use the git repository to get the latest version (with python 3.11 or 3.12):

git clone https://github.com/artefactory/woodtapper.git

And install the required packages into your environment (conda, mamba or pip):

pip install -e .[dev,docs]

Warning: If you are a Windows user, you need to have a C/C++ compiler before installing woodtapper.

Dependencies

WoodTapper requires the following:

  • Python (>=3.11,<3.13)
  • Numpy (>=2.3.1)
  • Scikit-learn (>=1.6.1)

Contributing

You are welcome to contribute to the project ! You can help in various ways:

  • raise issues
  • resolve issues already opened
  • develop new features
  • provide additional examples of use
  • fix typos, improve code quality
  • develop new tests

We recommend to first open an issue to discuss your ideas.

Citation

If you consider this package and any of its feature useful for your research, please cite us.

License

The use of this software is under the MIT license.