Python Scripts

There are several Python (the scripting language) scripts written to prepare input for and analyse the output of python (the C code).

Some of the more useful scripts/modules are documented below. Alternatively, you can generate documentation for all the scripts by navigating to docs/pydocs and running write_docs.py. The resulting output file can be found here.

Warning to user

The scripts documented here form an incomplete and inhomogenous list, in the sense that they have been developed by different people at different times and do not fit nicely together as a single python package. Some of the scripts should still be useful, particularly if you consult example notebookes, but use with caution!

Todo

Finish adding modules below.

• Plotting
  • py_plot_output
    • make_spec_comparison_plot()
    • make_spec_plot()
    • make_spec_plot_from_class()
    • make_wind_plot()
  • plot_wind
    • compare()
    • compare_separate()
    • doit()
    • get_data()
    • just_plot()
• Checking Runs and Testing
  • run_check
    • check_completion()
    • doit()
    • how_many_dimensions()
    • make_html()
    • plot_converged()
    • py_error()
    • read_diag()
    • steer()
    • windsave2table()
    • xwindsave2table()
• Utility, I/O and Imports
  • py_read_output
    • read_convergence()
    • read_emissivity()
    • read_pf()
    • read_pywind()
    • read_pywind_summary()
    • read_spectrum()
    • read_spectrum_to_class()
    • setpars()
    • thinshell_read()
    • write_pf()
  • py_plot_util
    • get_flux_at_wavelength()
    • get_pywind_summary()
    • parse_rcparams()
    • read_pywind_smart()
    • run_py_wind()
    • smooth()
    • wind_to_masked()
  • import_cyl
    • doit()
    • read_file()
    • read_table()
• py4py
  • py4py
    • load_grid()
    • plot_dat()
    • plot_dat_many()
    • plot_spec()
  • py4py.reverb
    • Origin
    • Photon
    • Spectrum
    • TransferFunction
      • TransferFunction.cont_scatters()
      • TransferFunction.count()
      • TransferFunction.delay()
      • TransferFunction.delay_bins()
      • TransferFunction.delay_dynamic_range()
      • TransferFunction.delay_peak()
      • TransferFunction.delays()
      • TransferFunction.emissivity()
      • TransferFunction.filter()
      • TransferFunction.fwhm()
      • TransferFunction.line()
      • TransferFunction.lines()
      • TransferFunction.plot()
      • TransferFunction.res_scatters()
      • TransferFunction.response()
      • TransferFunction.response_map_by_tf()
      • TransferFunction.response_total()
      • TransferFunction.run()
      • TransferFunction.spectrum()
      • TransferFunction.transfer_function_1d()
      • TransferFunction.velocities()
      • TransferFunction.wavelength_bins()
      • TransferFunction.wavelengths()
    • calculate_delay()
    • open_database()