ltbams 0.9.9__py3-none-any.whl → 1.0.0__py3-none-any.whl

docs/source/_generated/ams.system.System.rst

@@ -0,0 +1,189 @@
+ams.system.System
+=================
+
+.. currentmodule:: ams.system
+
+.. autoclass:: System
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated/
+
+   
+       
+       
+          ~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
+       
+   
+   
+
+   
+   
+   

docs/source/_generated/ams.system.disable_method.rst

@@ -0,0 +1,6 @@
+disable\_method
+===============
+
+.. currentmodule:: ams.system
+
+.. autofunction:: disable_method

docs/source/_generated/ams.system.disable_methods.rst

@@ -0,0 +1,6 @@
+disable\_methods
+================
+
+.. currentmodule:: ams.system
+
+.. autofunction:: disable_methods

docs/source/_generated/ams.system.example.rst

@@ -0,0 +1,6 @@
+example
+=======
+
+.. currentmodule:: ams.system
+
+.. autofunction:: example

docs/source/_generated/ams.system.rst

@@ -0,0 +1,39 @@
+ams.system
+==========
+
+.. automodule:: ams.system
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+   
+      disable_method
+      disable_methods
+      example
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+   
+      System
+   
+   
+
+   
+   
+   
+
+
+

docs/source/_generated/ams.utils.paths.DisplayablePath.rst

@@ -0,0 +1,42 @@
+ams.utils.paths.DisplayablePath
+===============================
+
+.. currentmodule:: ams.utils.paths
+
+.. autoclass:: DisplayablePath
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated/
+
+   
+       
+       
+          ~DisplayablePath.displayable
+       
+       
+          ~DisplayablePath.make_tree
+       
+   
+   
+
+   
+   
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: _generated/
+
+   
+      ~DisplayablePath.display_filename_prefix_last
+      ~DisplayablePath.display_filename_prefix_middle
+      ~DisplayablePath.display_parent_prefix_last
+      ~DisplayablePath.display_parent_prefix_middle
+      ~DisplayablePath.displayname
+   
+   

docs/source/_generated/ams.utils.paths.ams_root.rst

@@ -0,0 +1,6 @@
+ams\_root
+=========
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: ams_root

docs/source/_generated/ams.utils.paths.cases_root.rst

@@ -0,0 +1,6 @@
+cases\_root
+===========
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: cases_root

docs/source/_generated/ams.utils.paths.confirm_overwrite.rst

@@ -0,0 +1,6 @@
+confirm\_overwrite
+==================
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: confirm_overwrite

docs/source/_generated/ams.utils.paths.get_case.rst

@@ -0,0 +1,6 @@
+get\_case
+=========
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: get_case

docs/source/_generated/ams.utils.paths.get_config_path.rst

@@ -0,0 +1,6 @@
+get\_config\_path
+=================
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: get_config_path

docs/source/_generated/ams.utils.paths.get_dot_andes_path.rst

@@ -0,0 +1,6 @@
+get\_dot\_andes\_path
+=====================
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: get_dot_andes_path

docs/source/_generated/ams.utils.paths.get_log_dir.rst

@@ -0,0 +1,6 @@
+get\_log\_dir
+=============
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: get_log_dir

docs/source/_generated/ams.utils.paths.get_pkl_path.rst

@@ -0,0 +1,6 @@
+get\_pkl\_path
+==============
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: get_pkl_path

docs/source/_generated/ams.utils.paths.get_pycode_path.rst

@@ -0,0 +1,6 @@
+get\_pycode\_path
+=================
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: get_pycode_path

docs/source/_generated/ams.utils.paths.list_cases.rst

@@ -0,0 +1,6 @@
+list\_cases
+===========
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: list_cases

docs/source/_generated/ams.utils.paths.rst

@@ -0,0 +1,47 @@
+ams.utils.paths
+===============
+
+.. automodule:: ams.utils.paths
+
+   
+   
+   
+
+   
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+   
+      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
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+   
+      DisplayablePath
+   
+   
+
+   
+   
+   
+
+
+

docs/source/_generated/ams.utils.paths.tests_root.rst

@@ -0,0 +1,6 @@
+tests\_root
+===========
+
+.. currentmodule:: ams.utils.paths
+
+.. autofunction:: tests_root

docs/source/_templates/autosummary/base.rst

@@ -0,0 +1,5 @@
+{{ objname | escape | underline }}
+
+.. currentmodule:: {{ module }}
+
+.. auto{{ objtype }}:: {{ objname }}

docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,35 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :toctree: _generated/
+
+   {% for item in methods %}
+       {% if item != "__init__" %}
+          ~{{ name }}.{{ item }}
+       {% endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+      :toctree: _generated/
+
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,65 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+
+.. autosummary::
+   :recursive:
+
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/source/_templates/autosummary/module_toctree.rst

@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+
+.. autosummary::
+   :recursive:
+   :toctree:
+
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/source/api.rst

@@ -0,0 +1,102 @@
+.. _api_reference:
+
+=============
+API reference
+=============
+
+
+System
+======
+
+.. autosummary::
+   :maxdepth:4
+   :recursive:
+   :toctree: _generated
+   :caption: System
+   :template: autosummary/module_toctree.rst
+
+   ams.system
+
+
+Model
+======
+
+.. autosummary::
+   :maxdepth:4
+   :recursive:
+   :toctree: _generated
+   :caption: Model
+   :template: autosummary/module_toctree.rst
+
+   ams.core.model
+   ams.core.param
+   ams.core.service
+
+
+Routines
+========
+
+.. autosummary::
+   :maxdepth:4
+   :recursive:
+   :toctree: _generated
+   :caption: Routines
+   :template: autosummary/module_toctree.rst
+
+   ams.routines.routine
+   ams.routines.dcopf
+   ams.routines.pflow
+
+
+Optimization
+=============
+
+.. autosummary::
+   :maxdepth:4
+   :recursive:
+   :toctree: _generated
+   :caption: Optimization
+   :template: autosummary/module_toctree.rst
+
+   ams.opt
+
+
+I/O
+===
+
+.. autosummary::
+   :maxdepth:4
+   :toctree: _generated
+   :recursive:
+   :caption: I/O
+   :template: autosummary/module_toctree.rst
+
+   ams.io
+
+
+Interoperability
+================
+
+.. autosummary::
+   :maxdepth:4
+   :toctree: _generated
+   :recursive:
+   :caption: Interoperability
+   :template: autosummary/module_toctree.rst
+
+   ams.interface
+
+
+Others
+======
+
+.. autosummary::
+   :maxdepth:4
+   :toctree: _generated
+   :recursive:
+   :caption: Others
+   :template: autosummary/module_toctree.rst
+
+   ams.cli
+   ams.main
+   ams.utils.paths