Skip to content

Commit

Permalink
intro: add eurec4a[data] install
Browse files Browse the repository at this point in the history
  • Loading branch information
d70-t committed May 14, 2024
1 parent 24b2c66 commit f0e2bdb
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion how_to_eurec4a/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ The book chapters show datasets that are accessible online, i.e. you don't have
The scripts typically contain at minimum how to get a specific dataset and some simple plots of basic quantities. Most chapters include additional information from aircraft flight segments or further EUREC⁴A meta data, sometimes more sophisticated plots, or also a combination of variables from different datasets.

## How can you run the code?
In the chapters you will find a rocket icon (<i class="fas fa-rocket"></i>) in the top bar to the right. It provides two interactive ways to run the code: `Binder` and `LiveCode`. In both cases a virtual environment is created for you in the background by a click on the respective link and you don't have to take care of any requirements locally on your machine. Of course you can also run all the code locally as described in {doc}`running_locally`.
If you want to try out the code on your machine, you'll need a few libraries to access the referenced data.
The easiest way to set this up would be to install the `eurec4a` package with the `data` option, e.g.:
```
pip install eurec4a[data]
```
afterwards, you should have everything installed to access the data. For some examples, you may have to install additional libraries for some specialized plotting methods.
If you are looking for detailed instructions to set up the entire book project including all dependencies, please refer to {doc}`running_locally`.

If you want to give the chapters a really quick try and don't want to set up anything yourself, you'll find a rocket icon (<i class="fas fa-rocket"></i>) in the top bar to the right of each chapter. The icon provides two interactive ways to run the code: `Binder` and `LiveCode`. In both cases a virtual environment is created for you in the background by a click on the respective link and you don't have to take care of any requirements locally on your machine.

In principle, we anticipate to have at minimum one example script per instrument and we are very happy about contributions by you :)
If you miss some information that could be valuable, feel free to check the link on [how to contribute](https://github.com/eurec4a/how_to_eurec4a/blob/master/CONTRIBUTING.md) to this book and make a pull request or open an issue on github if you are short on time. Thanks!
Expand Down

0 comments on commit f0e2bdb

Please sign in to comment.