You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/index.rst
+19-19
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,14 @@ ChromaX: a fast and scalable breeding program simulator
9
9
ChromaX is a Python library that enables the simulation of genetic recombination, genomic estimated
10
10
breeding value calculations, and selection processes.
11
11
The library is based on `JAX <https://jax.readthedocs.io>`_ to exploit parallelization.
12
-
It can smoothly operate on CPU, GPU (NVIDIA, AMD, and Intel), or TPU.
13
-
14
-
.. note::
15
-
16
-
At the moment, JAX, thus ChromaX supports Apple silicon GPU exclusively through the Metal plug-in, which is still in the experimental release phase.
17
-
For additional information, please refer to `Apple's JAX on Metal documentation <https://developer.apple.com/metal/jax/>`_.
12
+
It can smoothly operate on CPU, GPU (NVIDIA, Apple, AMD, and Intel), or TPU.
18
13
19
14
Installation
20
15
===================================
16
+
.. note::
17
+
18
+
To exploit parallelization capabilities of your hardware, it is recommended to install jax manually.
19
+
You can find the instruction for your hardware in `google/jax <https://github.com/google/jax?tab=readme-ov-file#installation>`_.
21
20
22
21
You can install the library via Python Package manager `pip`:
23
22
@@ -38,19 +37,20 @@ To cite ChromaX in publications:
38
37
39
38
.. code-block:: bibtex
40
39
41
-
@article{Younis2023.05.29.542709,
42
-
abstract = {ChromaX is a Python library that enables the simulation of genetic recombination, genomic estimated breeding value calculations, and selection processes. By utilizing GPU processing, it can perform these simulations up to two orders of magnitude faster than existing tools with standard hardware. This offers breeders and scientists new opportunities to simulate genetic gain and optimize breeding schemes.},
43
-
author = {Omar G. Younis and Matteo Turchetta and Daniel Ariza Suarez and Steven Yates and Bruno Studer and Ioannis N. Athanasiadis and Andreas Krause and Joachim M. Buhmann and Luca Corinzia},
author = {Younis, Omar G and Turchetta, Matteo and Ariza Suarez, Daniel and Yates, Steven and Studer, Bruno and Athanasiadis, Ioannis N and Krause, Andreas and Buhmann, Joachim M and Corinzia, Luca},
42
+
title = "{ChromaX: a fast and scalable breeding program simulator}",
43
+
journal = {Bioinformatics},
44
+
volume = {39},
45
+
number = {12},
46
+
pages = {btad691},
47
+
year = {2023},
48
+
month = {11},
49
+
abstract = "{ChromaX is a Python library that enables the simulation of genetic recombination, genomic estimated breeding value calculations, and selection processes. By utilizing GPU processing, it can perform these simulations up to two orders of magnitude faster than existing tools with standard hardware. This offers breeders and scientists new opportunities to simulate genetic gain and optimize breeding schemes.The documentation is available at https://chromax.readthedocs.io. The code is available at https://github.com/kora-labs/chromax.}",
0 commit comments