Logo
  • About
    • Scheduling System Integration
    • DM Experiment Management
  • Install
    • Install
    • Configure
      • Credentials
      • DM environment variables
      • DMagic configuration file
    • Test
    • Update
  • Usage
    • Initialization
    • Scheduling System Commands
      • dmagic show
      • dmagic tag
      • dmagic tag-manual
    • DM Experiment Management
      • dmagic create
      • dmagic create-manual
      • dmagic delete
      • dmagic email
      • dmagic daq-start
      • dmagic daq-stop
      • dmagic upload
      • dmagic add-user
      • dmagic remove-user
      • dmagic list-users
    • Command Reference
  • API reference
    • dmagic.authorize
      • basic()
      • read_credentials()
    • dmagic.scheduling
      • beamtime_requests()
      • current_run()
      • get_beamtime()
      • get_current_emails()
      • get_current_pi()
      • get_current_proposal()
      • get_current_proposal_id()
      • get_current_proposal_title()
      • get_current_users()
      • list_beamtimes()
    • dmagic.dm
      • add_users()
      • create_experiment()
      • delete_experiment()
      • get_emailed_users()
      • get_esaf_doi()
      • get_esaf_users()
      • get_experiment()
      • get_user()
      • list_experiments_by_station()
      • list_users_this_dm_exp()
      • make_data_link()
      • make_dm_username_list()
      • make_experiment_name()
      • make_pretty_user_name()
      • make_user_email_list()
      • make_username_list()
      • remove_users()
      • set_emailed_users()
      • start_daq()
      • stop_daq()
      • upload()
    • dmagic.message
      • html_to_text()
      • message()
      • send_email()
      • yes_or_no()
    • dmagic.utils
      • clean_entry()
      • fix_iso()
DMagic
  • API reference
  • Edit on GitHub

API referenceΒΆ

This section contains the API reference and usage information for DMagic.

DMagic Modules:

  • dmagic.authorize
    • basic()
    • read_credentials()
  • dmagic.scheduling
    • beamtime_requests()
    • current_run()
    • get_beamtime()
    • get_current_emails()
    • get_current_pi()
    • get_current_proposal()
    • get_current_proposal_id()
    • get_current_proposal_title()
    • get_current_users()
    • list_beamtimes()
  • dmagic.dm
    • add_users()
    • create_experiment()
    • delete_experiment()
    • get_emailed_users()
    • get_esaf_doi()
    • get_esaf_users()
    • get_experiment()
    • get_user()
    • list_experiments_by_station()
    • list_users_this_dm_exp()
    • make_data_link()
    • make_dm_username_list()
    • make_experiment_name()
    • make_pretty_user_name()
    • make_user_email_list()
    • make_username_list()
    • remove_users()
    • set_emailed_users()
    • start_daq()
    • stop_daq()
    • upload()
  • dmagic.message
    • html_to_text()
    • message()
    • send_email()
    • yes_or_no()
  • dmagic.utils
    • clean_entry()
    • fix_iso()
Previous Next

© Copyright 2013-2015, Argonne National Laboratory.

Built with Sphinx using a theme provided by Read the Docs.