Skip to main content
Ctrl+K

AMS 0.8.4 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
    • disable_method
    • disable_methods
    • example
    • ams.system.System
      • System.add
      • System.as_dict
      • System.calc_pu_coeff
      • System.call_models
      • System.collect_config
      • System.collect_ref
      • System.connectivity
      • System.e_clear
      • System.f_update
      • System.fg_to_dae
      • System.find_devices
      • System.find_models
      • System.from_ipysheet
      • System.g_islands
      • System.g_update
      • System.get_z
      • System.import_groups
      • System.import_models
      • System.import_routines
      • System.import_types
      • System.init
      • System.j_islands
      • System.j_update
      • System.l_update_eq
      • System.l_update_var
      • System.link_ext_param
      • System.precompile
      • System.prepare
      • System.reload
      • System.remove_pycapsule
      • System.report
      • System.reset
      • System.s_update_post
      • System.s_update_var
      • System.save_config
      • System.set_address
      • System.set_config
      • System.set_dae_names
      • System.set_output_subidx
      • System.set_var_arrays
      • System.setup
      • System.store_adder_setter
      • System.store_existing
      • System.store_no_check_init
      • System.store_sparse_pattern
      • System.store_switch_times
      • System.summary
      • System.supported_models
      • System.supported_routines
      • System.switch_action
      • System.to_andes
      • System.to_ipysheet
      • System.undill
      • System.vars_to_dae
      • System.vars_to_models

Model

  • ams.core.model
    • ams.core.model.Model
      • Model.alter
      • Model.doc
      • Model.get
      • Model.get_idx
      • Model.idx2uid
      • Model.list2array
      • Model.set
      • Model.set_backref
      • Model.class_name
  • ams.core.param
    • ams.core.param.RParam
      • RParam.get_idx
      • RParam.parse
      • RParam.update
      • RParam.class_name
      • RParam.dtype
      • RParam.n
      • RParam.shape
      • RParam.size
      • RParam.v
  • ams.core.service
    • ams.core.service.LoadScale
      • LoadScale.assign_memory
      • LoadScale.get_names
      • LoadScale.parse
      • LoadScale.update
      • LoadScale.class_name
      • LoadScale.n
      • LoadScale.shape
      • LoadScale.size
      • LoadScale.v
    • ams.core.service.MinDur
      • MinDur.assign_memory
      • MinDur.get_names
      • MinDur.parse
      • MinDur.update
      • MinDur.class_name
      • MinDur.n
      • MinDur.shape
      • MinDur.size
      • MinDur.v
      • MinDur.v0
      • MinDur.v1
    • ams.core.service.NumExpandDim
      • NumExpandDim.assign_memory
      • NumExpandDim.get_names
      • NumExpandDim.parse
      • NumExpandDim.update
      • NumExpandDim.class_name
      • NumExpandDim.n
      • NumExpandDim.shape
      • NumExpandDim.size
      • NumExpandDim.v
      • NumExpandDim.v0
      • NumExpandDim.v1
    • ams.core.service.NumHstack
      • NumHstack.assign_memory
      • NumHstack.get_names
      • NumHstack.parse
      • NumHstack.update
      • NumHstack.class_name
      • NumHstack.n
      • NumHstack.shape
      • NumHstack.size
      • NumHstack.v
      • NumHstack.v0
      • NumHstack.v1
    • ams.core.service.NumOp
      • NumOp.assign_memory
      • NumOp.get_names
      • NumOp.parse
      • NumOp.update
      • NumOp.class_name
      • NumOp.n
      • NumOp.shape
      • NumOp.size
      • NumOp.v
      • NumOp.v0
      • NumOp.v1
    • ams.core.service.NumOpDual
      • NumOpDual.assign_memory
      • NumOpDual.get_names
      • NumOpDual.parse
      • NumOpDual.update
      • NumOpDual.class_name
      • NumOpDual.n
      • NumOpDual.shape
      • NumOpDual.size
      • NumOpDual.v
      • NumOpDual.v0
      • NumOpDual.v1
    • ams.core.service.RBaseService
      • RBaseService.assign_memory
      • RBaseService.get_names
      • RBaseService.parse
      • RBaseService.update
      • RBaseService.class_name
      • RBaseService.n
      • RBaseService.shape
      • RBaseService.size
      • RBaseService.v
    • ams.core.service.ROperationService
      • ROperationService.assign_memory
      • ROperationService.get_names
      • ROperationService.parse
      • ROperationService.update
      • ROperationService.class_name
      • ROperationService.n
      • ROperationService.shape
      • ROperationService.size
      • ROperationService.v
    • ams.core.service.RampSub
      • RampSub.assign_memory
      • RampSub.get_names
      • RampSub.parse
      • RampSub.update
      • RampSub.class_name
      • RampSub.n
      • RampSub.shape
      • RampSub.size
      • RampSub.v
      • RampSub.v0
      • RampSub.v1
    • ams.core.service.ValueService
      • ValueService.assign_memory
      • ValueService.get_names
      • ValueService.parse
      • ValueService.update
      • ValueService.class_name
      • ValueService.n
      • ValueService.shape
      • ValueService.size
      • ValueService.v
    • ams.core.service.VarReduction
      • VarReduction.assign_memory
      • VarReduction.get_names
      • VarReduction.parse
      • VarReduction.update
      • VarReduction.class_name
      • VarReduction.n
      • VarReduction.shape
      • VarReduction.size
      • VarReduction.v
      • VarReduction.v0
      • VarReduction.v1
    • ams.core.service.VarSelect
      • VarSelect.assign_memory
      • VarSelect.get_names
      • VarSelect.parse
      • VarSelect.update
      • VarSelect.class_name
      • VarSelect.n
      • VarSelect.shape
      • VarSelect.size
      • VarSelect.v
      • VarSelect.v0
      • VarSelect.v1
    • ams.core.service.ZonalSum
      • ZonalSum.assign_memory
      • ZonalSum.get_names
      • ZonalSum.parse
      • ZonalSum.update
      • ZonalSum.class_name
      • ZonalSum.n
      • ZonalSum.shape
      • ZonalSum.size
      • ZonalSum.v
      • ZonalSum.v0
      • ZonalSum.v1

Routines

  • ams.routines.routine
    • ams.routines.routine.RoutineModel
      • RoutineModel.addConstrs
      • RoutineModel.addRParam
      • RoutineModel.addService
      • RoutineModel.addVars
      • RoutineModel.dc2ac
      • RoutineModel.disable
      • RoutineModel.doc
      • RoutineModel.enable
      • RoutineModel.export_csv
      • RoutineModel.get
      • RoutineModel.get_load
      • RoutineModel.igmake
      • RoutineModel.igraph
      • RoutineModel.init
      • RoutineModel.prepare
      • RoutineModel.run
      • RoutineModel.set
      • RoutineModel.solve
      • RoutineModel.summary
      • RoutineModel.unpack
      • RoutineModel.update
      • RoutineModel.class_name

Optimization

  • ams.opt.omodel
    • ams.opt.omodel.Constraint
      • Constraint.parse
      • Constraint.class_name
      • Constraint.n
      • Constraint.shape
      • Constraint.size
      • Constraint.v
      • Constraint.v2
    • ams.opt.omodel.OModel
      • OModel.init
      • OModel.update
      • OModel.class_name
    • ams.opt.omodel.Objective
      • Objective.parse
      • Objective.class_name
      • Objective.n
      • Objective.shape
      • Objective.size
      • Objective.v
      • Objective.v2
    • ams.opt.omodel.OptzBase
      • OptzBase.parse
      • OptzBase.class_name
      • OptzBase.n
      • OptzBase.shape
      • OptzBase.size
    • ams.opt.omodel.Param
      • Param.parse
      • Param.update
      • Param.class_name
      • Param.n
      • Param.shape
      • Param.size
    • ams.opt.omodel.Var
      • Var.get_idx
      • Var.parse
      • Var.class_name
      • Var.n
      • Var.shape
      • Var.size
      • Var.v

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
      • build_group_table
      • make_link_table
      • parse_addfile
      • to_andes
      • ams.interop.andes.Dynamic
        • Dynamic.link_andes
        • Dynamic.receive
        • Dynamic.send
        • Dynamic.is_tds

Others

  • ams.cli
    • create_parser
    • main
    • preamble
  • 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
    • ams_root
    • cases_root
    • confirm_overwrite
    • get_case
    • get_config_path
    • get_dot_andes_path
    • get_log_dir
    • get_pkl_path
    • get_pycode_path
    • list_cases
    • tests_root
    • ams.utils.paths.DisplayablePath
      • DisplayablePath.displayable
      • DisplayablePath.make_tree
      • DisplayablePath.display_filename_prefix_last
      • DisplayablePath.display_filename_prefix_middle
      • DisplayablePath.display_parent_prefix_last
      • DisplayablePath.display_parent_prefix_middle
      • DisplayablePath.displayname
  • API reference
  • ams.utils.paths
  • ams.utils.pa...

ams.utils.paths.DisplayablePath#

class ams.utils.paths.DisplayablePath(path, parent_path, is_last)[source]#
__init__(path, parent_path, is_last)[source]#

Methods

displayable()

make_tree(root[, parent, is_last, criteria])

Attributes

display_filename_prefix_last

display_filename_prefix_middle

display_parent_prefix_last

display_parent_prefix_middle

displayname

previous

tests_root

next

DisplayablePath.displayable

On this page
  • DisplayablePath
    • DisplayablePath.__init__()
Edit on GitHub
Show Source

© Copyright 2023-2024, Jinning Wang.

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.15.2.