Welcome to CraFT book¶
The aim of this toolbox is to provide a tools to performed data analysis on CraFT output.
Those analysis are build around xarray librairy and few accessor xarray_craft, xarray_aita.
All this documentation is build from jupyter-notebook and can be run using MyBinder by clicking on the “launch button” on the top right of this page (the little rocket 🚀).
Tutorials¶
Quick start : Short tutorial.
Install environement¶
If you want to install your the python environnement locally on your computer, we recomand using conda. You can follow this quick start to set-up conda.
Once conda is set-up you can install your environement using the environment.yml file.
conda env create -n MyenvCraFT -f environment.yml
To activate this environment use :
conda activate MyenvCraFT
Play with the notebooks on your computer¶
You can clone this repository :
git clone https://github.com/ThomasChauve/DIC-book
Contribute¶
You are welcome to contribute to the project. Here are some way to contribute to it :
Submit commit to fix bug or add news functionalities.
Repport issues that you found using those tools.
Talk about the tools around you if you find it interesting and/or put a star on it.
Feel free to contact me if you like to discuss about it.