Skip to content

Multiomics-Analytics-Group/acore

Repository files navigation

ACore Logo

ACore is Python package with statistical functions to analyse multimodal molecular data

Information Links
Package PyPI Latest Release Supported versions Supported implementations License: GPL v3
Documentation View - Documentation made-with-sphinx-doc Docs CC BY 4.0
Build CI
Discuss on GitHub GitHub issues GitHub pull requests

Table of contents:

About the project

ACore is Python package with statistical functions to analyse multimodal molecular data. It is part of a broader ecosystem of tools for multi-omics analysis, working in conjunction with [VueCore][acore] and VueGen to enable end-to-end data processing, visualization, and reporting.

Installation

Tip

It is recommended to install ACore inside a virtual environment to manage depenendencies and avoid conflicts with existing packages. You can use the virtual environment manager of your choice, such as poetry, conda, or pipenv.

Pip

ACore is available on PyPI and can be installed using pip:

pip install acore

You can also install the package for development by cloning this repository and running the following command:

Warning

We assume you are in the root directory of the cloned repository when running this command. Otherwise, you need to specify the path to the acore directory.

pip install -e '.[dev]'

To run all tests, you can use the following command:

pytest

Documentation

ACore's documentation is hosted on Read the Docs. It includes installation instructions, various tutorials, configuration options, and the API reference.

License

The code in this repository is licensed under the GNU General Public License v3, allowing you to use, modify, and distribute it freely as long as you include the original copyright and license notice.

The documentation and other creative content are licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License, meaning you are free to share and adapt it with proper attribution.

Full details for both licenses can be found in the LICENSE file.

Contributing

ACore is an open-source project, and we welcome contributions of all kinds via GitHub issues and pull requests. You can report bugs, suggest improvements, propose new features, or implement changes. Please follow the guidelines in the CONTRIBUTING file to ensure that your contribution is easily integrated into the project.

Credits and acknowledgements

Contact and feedback

We appreciate your feedback! If you have any comments, suggestions, or run into issues while using ACore, feel free to open an issue in this repository. Your input helps us make ACore better for everyone.

About

Functionality to preprocess and analyse multi-omics data

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 5