Skip to Content

DEMO - Documentation

Version 21.1 by cpassow on 2022-04-05 14:40
The system could not automatically merge data from remote copies of this document, or the merge may have been performed incorrectly. Alternative versions have been saved to the document history. You may need to copy data from past revisions into the latest version of this document. Please mark the document as resolved once you are comfortable it is correct and coherent.

test

TODO

  • Short descriptions including Links:   → as Text
    • GPFS
    • JupyterHub
    • conda ?


  • distribution
    • channel  (where to host?)
    • environment file (repository with examples)


  • Documentation
    • here VS repository vs sphinx


  • Binder
    • examples with Stefan


  • Screencast
    • login in jupyter hub
    • login maxwell display
    • use slix
    • use hdfview plugin in jupterLab
    • create conda env with flashh5



under review


conda create -n flashh5 python=3.10  # 3.10 not necessary, but would prefer 3.8 or higher
source activate flashh5
conda install ipython numpy pandas  #TODO: fix dependcies
conda install -c https://www.desy.de/~cpassow/condarepo/ flashh5

## on jhub
conda install ipykernel
python -m ipykernel install --user --name flashh5 --display-name "flashh5"


## to remove on jhub
## delete from: /home/$USER/.local/share/jupyter/kernels/


moved to repository?
class RunDirectory:
       
   def get_run_table():  # more or less information? RunComment | Number of Files | start & stop time ? 
       ...
   
   def get_run(daq, run_number):  # daq is not needed!

       ...
   
   
class Run:
       
   def get_files():
       ...
   
   def get_channels():  # of file #1
       ...

   def get_start_time(): # better as attribute?
       ...
   
   def get_stop_time():  # which?  |  better as attribute?
       ...

   def to_df(daq_map):  # to_df(daq_map, slice) slice=[0:4] -> throw Exception
       ...
   
   def to_series(channel):
       ...
   
   def to_array(channel):
       ...
ideas
run.to_df(daq_map)
run.to_series(daq_adr or daq_map) # on channel only?
run.to_array(daq_adr) # on channel only? 

## interesting?
# run.to_dask(daq_map)
# run.to_xarray(daq_map)