Skip to content

Commit 8f14e77

Browse files
committed
docs
1 parent 7d24a2e commit 8f14e77

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/index.rst

+19-19
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,14 @@ ChromaX: a fast and scalable breeding program simulator
99
ChromaX is a Python library that enables the simulation of genetic recombination, genomic estimated
1010
breeding value calculations, and selection processes.
1111
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.
1813

1914
Installation
2015
===================================
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>`_.
2120

2221
You can install the library via Python Package manager `pip`:
2322

@@ -38,19 +37,20 @@ To cite ChromaX in publications:
3837

3938
.. code-block:: bibtex
4039
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},
44-
doi = {10.1101/2023.05.29.542709},
45-
elocation-id = {2023.05.29.542709},
46-
eprint = {https://www.biorxiv.org/content/early/2023/05/31/2023.05.29.542709.1.full.pdf},
47-
journal = {bioRxiv},
48-
publisher = {Cold Spring Harbor Laboratory},
49-
title = {ChromaX: a fast and scalable breeding program simulator},
50-
url = {https://www.biorxiv.org/content/early/2023/05/31/2023.05.29.542709.1},
51-
year = {2023},
52-
bdsk-url-1 = {https://www.biorxiv.org/content/early/2023/05/31/2023.05.29.542709.1},
53-
bdsk-url-2 = {https://doi.org/10.1101/2023.05.29.542709}
40+
@article{10.1093/bioinformatics/btad691,
41+
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.}",
50+
issn = {1367-4811},
51+
doi = {10.1093/bioinformatics/btad691},
52+
url = {https://doi.org/10.1093/bioinformatics/btad691},
53+
eprint = {https://academic.oup.com/bioinformatics/article-pdf/39/12/btad691/54143193/btad691.pdf},
5454
}
5555
5656
.. toctree::

0 commit comments

Comments
 (0)