A python port for the CytoNorm R library.
It is recommended to choose conda as your package manager. Conda can be obtained, e.g., by installing the Miniconda distribution. For detailed instructions, please refer to the respective documentation.
With conda installed, open your terminal and create a new environment by executing the following commands::
conda create -n cytonormpy python=3.10
conda activate cytonormpy
Currently, cytonormpy is in beta-phase. There will be a PyPI release once the beta phase is finished.
pip install cytonormpy
In order to get the latest version, install from GitHub using
pip install git+https://github.com/TarikExner/CytoNormPy@main
Alternatively, clone the repository to your local hard drive via
git clone https://github.com/TarikExner/CytoNormPy.git && cd CytoNormpy
git checkout --track origin/main
pip install .[docs, test]
Jupyter notebooks are highly recommended due to their extensive visualization capabilities. Install jupyter via
conda install jupyter
and run the notebook by entering jupyter-notebook
into the terminal.
Please refer to the documentation. Examples are found under "vignettes" and currently include:
Your contributions are welcome!
Please submit an issue or pull request via Github! Pull requests with updated documentation and accompanying unit tests are preferred but not obligate!