XAOSIM reference documentation

Table of Contents

sticker_print_test.png

1 Introduction

Congratulations: you have reached the documentation page of the XAOSIM python simulation package developed by Frantz Martinache! This is the index page of the documentation.

XAOSIM is a python package that was primarily designed for a Linux operating system. The package takes full advantage of some of the features of this operating system. The software also runs on Mac, but no attempt has really been made to ensure that the performance is the same. As for Windows users, you are on your own. I am completely clueless when it comes to your OS.

2 Download and installation

Before digging into the documentation, make sure that you have the latest version of XAOSIM installed on your computer. Download in on github.com!

The recommended installation procedure is after download, to use the following command:

python setup.py install --user

It is also recommended to add the ~/.local/bin/ directory to the user path:

export PATH=$HOME/.local/bin/:$PATH

After that, you should be good to go!

3 Software documentation

4 Acknowledgement

The XAOSIM software and this documentation are developments carried out in the context of the KERNEL project. KERNEL has received funding from the European Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement CoG - 683029). For more information about the KERNEL project, visit: http://frantzmartinache.eu/index.php/category/kernel/

erc_banner-horizontal.jpg


XAOSIM documentation page
Author: Frantz Martinache