Skip to main content

Ctrl+K

AMS 0.9.6.post5+gef1d8a0 documentation

Getting started
Examples
Development
Release notes
Routine reference
- Model reference
- API reference

Getting started
Examples
Development
Release notes
Routine reference
- Model reference
- API reference

Section Navigation

System

ams.system

Model

ams.core.model
- ams.core.model.Model
ams.core.param
- ams.core.param.RParam
ams.core.service

Routines

ams.routines.routine
- ams.routines.routine.RoutineBase

Optimization

ams.opt.omodel

I/O

ams.io
- guess
- parse
- ams.io.json
  - write
- ams.io.matpower
  - mpc2system
  - read
  - system2mpc
  - testlines
- ams.io.psse
- ams.io.pypower
  - ppc2system
  - py2ppc
  - read
  - system2ppc
  - testlines
- ams.io.xlsx
  - write

Interoperability

ams.interop
- ams.interop.andes

Others

ams.cli
ams.main
- config_logger
- demo
- doc
- edit_conf
- find_log_path
- load
- misc
- print_license
- remove_output
- run
- run_case
- save_conf
- selftest
- set_logger_level
- versioninfo
ams.utils.paths

API reference
ams.routines.routine.RoutineBase
RoutineBase.doc

RoutineBase.doc#

RoutineBase.doc(max_width=78, export='plain')[source]#: Retrieve routine documentation as a string.

previous

RoutineBase.disable

next

RoutineBase.enable

On this page

RoutineBase.doc()

© Copyright 2023-2024, Jinning Wang.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.2.