Update intro and readme text

tmieslinger commented 3 years ago

I suggest an update of the README.md moving some notes on myst and building the book to the file CONTRIBUTING.md.
I added some more information to the introduction to the book
a major change that I would like to suggest is to get more precise on the code examples and rephrase them to HALO as we only have HALO code examples so par. That way we and others can easily add further scripts, while keeping an overview. What do you think about that?

MeraX commented 3 years ago

I wonder if it would make sense to highlight more of the "custom requrements" compared to general stuff like numy, matplotlib and xarray.

At least I would like to install just those packages that are necessary to execute some of the examples in my environment. I had the basics installed, but was for example wondering about the eurec4a module. (Note, it is available on PyPi and GH.

Therefore, I would welcome if you/we would highlight those packages that were built for EUREC4A and this how_to_eurec4a. I think it is especially the eurec4a package. Perhaps also intake, intake-xarray, and `ipfsspec>=0.0.2' (?).

I'm always a bit hesitant to install a lot of random packages without understanding their need. Would it make sense to highlight all packagees required in each notebook at its beginning?

And are actually all requirements listed in requirements.txt directly necessary or are some of them only required by e.g. eurec4a and thus also listed in eurec4a's requirements?

d70-t commented 3 years ago

I fixes the smaller things we've discussed previously and am currently in the process of adding a little "running locally" chapter which will be linked from the intro page. This should provide a little more explanation about the required things but as discussed in #27 the exact requirements for local environments might still change a bit in the next time.

d70-t commented 3 years ago

I've added a few commits. @tmieslinger, @MeraX are you happy with the situation? I'd be happy to merge it as is.

MeraX commented 3 years ago

Grounding but very happy.

Your commits address several of my issues

eurec4a / how_to_eurec4a

Update intro and readme text #25