Skip to content

IOR-BIC/AlbaWrap

Repository files navigation

AlbaWrap

AlbaWrap is a Python wrapper for the ALBA Library, designed to expose its core functionalities in a way that can be seamlessly utilized in Python environments. This project aims to bridge the gap between C++ implementations of ALBA and both Python developers and researchers in the biomedical field.


Features

  • Efficient Wrapping: Access ALBA functionalities without delving into complex C++ implementations.
  • Python-Friendly API: Intuitive APIs for developers familiar with Python.
  • Cross-Platform Compatibility: Compatible with major operating systems.
  • Extendable: Designed for easy extension to accommodate new features from ALBA.

Requirements

Before using AlbaWrap, ensure that you have the following dependencies installed:

  • ALBA Library: GitHub Repository
  • Python: Version 3.7 or later
  • CMake: Version 3.16 or later
  • GCC/Clang/MSVC: Visual studio 2015 or higher

Usage

WIP

Contributing

Contributions are welcome! If you'd like to contribute to AlbaWrap, please follow these steps:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature-name).
  3. Commit your changes (git commit -m 'Add feature').
  4. Push to the branch (git push origin feature-name).
  5. Open a pull request.

Please ensure your code adheres to the project's coding standards and includes relevant tests.


License

AlbaWrap use license agreement

This is an open-source copyright as follows:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Modified source versions must be plainly marked as such, and must not be misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Acknowledgments

AlbaWrap is developed and maintained by IOR-BIC

About

Alba Python Wrapping Library

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors