Skip to content
/ xomx Public
forked from perrin-isir/xomx

a python library providing data processing and machine learning tools for computational omics, with emphasis on explainability

License

Notifications You must be signed in to change notification settings

polklin/xomx

 
 

Repository files navigation

alt text

version codestyle

xomx is an open-source python library providing data processing and machine learning tools for computational omics, with a particular emphasis on explainability.

It relies on AnnData objects, which makes it fully compatible with Scanpy.

xomx is currently in beta version.


Install

Option 1: pip

pip install git+https://github.com/perrin-isir/xomx

Option 2: conda

git clone https://github.com/perrin-isir/xomx.git
cd xomx

Choose a conda environmnent name, for instance xomxv.
The following command creates the xomxv environment with the requirements listed in environment.yaml:

conda env create --name xomxv --file environment.yaml

If you prefer to update an existing environment (existing_env):

conda env update --name existing_env --file environment.yml

To activate the xomxv environment:

conda activate xomxv

Finally, to install the xomx library in the activated virtual environment:

pip install -e .


Tutorials

Tutorials (in xomx/tutorials/) are the best way to learn to use xomx.

List of tutorials:


Citing the project

To cite this repository in publications:

@misc{xomx,
  author = {Perrin-Gilbert, Nicolas and Vibert, Julien and Vandenbogaert, Mathias and Waterfall, Joshua J.},
  title = {xomx},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/perrin-isir/xomx}},
}

About

a python library providing data processing and machine learning tools for computational omics, with emphasis on explainability

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 89.6%
  • Python 10.4%