search

European-XFEL / karabo_data

Python tools to read and analyse data from European XFEL
https://karabo-data.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
13 stars 7 forks source link

Add quickstart to docs home page #213

Closed takluyver closed 5 years ago

takluyver commented 5 years ago

Showing only the most fundamental things karabo_data can do.

I have a small reservation about this, that once there's a quickstart no-one will ever look beyond it to see anything else karabo_data can do. On the other hand, I think hardly anyone looks at the more detailed documentation anyway, so having a short summary might get people started more usefully. And I've tried to integrate links to take people into the detailed documentation.

cc @RobertRosca - this relates to what you were saying this morning, that people don't know about loading individual files.

codecov-io commented 5 years ago

Codecov Report

Merging #213 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #213   +/-   ##
=======================================
  Coverage   86.98%   86.98%           
=======================================
  Files          17       17           
  Lines        2590     2590           
=======================================
  Hits         2253     2253           
  Misses        337      337

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3122166...bcdb60e. Read the comment docs.