Starting dysh

Starting dysh#

dysh shell#

dysh comes with two pre-configured interfaces that can be started from the command line. The first, dysh, will start an IPython shell with common dysh classes, and astropy, numpy, and pandas modules already imported. dysh has a number of command line options, viewable with --help

dysh --help

usage: dysh [-h] [-i] [-p PATHS [PATHS ...]] [-P PROFILE] [-L FITS_LOADER] [--colors {NoColor,Neutral,Linux,LightBG}] [-v {0,1,2,3}]
         [--log LOG] [-q] [--version] [--skip-config] [--hide-tb]
         [file]

Dysh interactive shell. All CLI arguments other than those defined below are passed through to ipython; see $ ipython --help for more
details

positional arguments:
  file                  Path to a Dysh Script to run

options:
  -h, --help            show this help message and exit
  -i, --interactive     Remain in interactive mode after running a script
  -p PATHS [PATHS ...], --paths PATHS [PATHS ...]
                        FITS file paths to load initially
  -P PROFILE, --profile PROFILE
                        The IPython profile to use
  -L FITS_LOADER, --fits-loader FITS_LOADER
                        The SDFITS loader class name to use
  --colors {NoColor,Neutral,Linux,LightBG}
                        Set the color scheme
  -v {0,1,2,3}, --verbosity {0,1,2,3}
                        Set logging verbosity
  --log LOG             Specify log path
  -q, --quiet           Silence DEBUG- and INFO-level logs to stderr
  --version             Print version and exit
  --skip-config         Skip creating a configuration file
  --hide-tb             Hide traceback
  -s, --system-info     Provide system information for bug reports

IPython Tips#

IPython is rich, and dysh shell inherits most of it. Describing the IPython options and features is beyond the scope of this documentation, but here we provide a few selected tips.

IPython startup#

When IPython starts it will look for files under ~/.ipython/ (the default, unless the system variable IPYTHONDIR is set). In there, you will find a profile_dysh/startup directory. Any scripts located under that directory will be run on the startup of dysh shell.

IPython magics#

These are convenience functions invoked with a % at the start. Some useful ones are:

  • history

    For example, to save the current session history of commands to a file:

    %history -f dysh-session.log

  • run

    To run a script from inside dysh shell.

A list of built in magic commands can be found in this link.

dysh lab#

There is also a custom JupyterLab interface, dysh-lab, which will start a JupyterLab server and open a launcher in your browser.

Note

At GBO dysh-lab will not launch a web browser. You must direct your web browser to the appropriate location, and set up a tunnel if working through ssh.

dysh-lab --help

usage: dysh-lab [-h] [--version] [--no-browser]

Dysh lab

options:
  -h, --help    show this help message and exit
  --version     Print version and exit
  --no-browser  Do not open browser automatically
Contents