Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d594b81
feat: ``session`` submodule
clatapie May 6, 2025
b7d185a
chore: adding changelog file 3894.documentation.md [dependabot-skip]
pyansys-ci-bot May 6, 2025
d7e2653
chore: adding changelog file 3895.documentation.md [dependabot-skip]
pyansys-ci-bot May 6, 2025
d270dec
feat: commands ordered by name
clatapie May 23, 2025
f46fea4
feat: commands ordered by pyname
clatapie May 23, 2025
7058040
Merge branch 'feat/main_commands' into feat/session_submodule
clatapie May 23, 2025
d3153d7
fix: removing ``slashexit`` + commenting ``mypy`` as it is not working
clatapie May 23, 2025
15d962a
chore: merge remote-tracking branch 'origin/feat/main_commands' into …
germa89 May 27, 2025
16afab3
fix: update no abort logging and command execution in MapdlGrpc class…
germa89 May 27, 2025
dd610d5
fix: uncomment mypy hook configuration in pre-commit settings
germa89 May 27, 2025
0ec8c46
delete: remove duplicated fragment
germa89 May 27, 2025
1f47975
fix: improve cwd method to validate directory paths and handle quotes…
germa89 May 27, 2025
f9eea4e
feat: adding latest enhancements
clatapie May 30, 2025
b20d382
feat: applying latest ``pyconverter-xml2py`` changes
clatapie Jun 3, 2025
8797d0e
Merge branch 'feat/main_commands' into feat/session_submodule
clatapie Jun 3, 2025
009cfda
chore: adding changelog file 3895.miscellaneous.md [dependabot-skip]
pyansys-ci-bot Jun 3, 2025
68bd1af
Merge branch 'feat/main_commands' into feat/session_submodule
clatapie Jun 10, 2025
8f2155e
feat: adding warnings and latest enhancements
clatapie Jun 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/3894.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
feat: ``session`` submodule
1 change: 1 addition & 0 deletions doc/changelog.d/3895.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
feat: ``session`` submodule
42 changes: 23 additions & 19 deletions doc/source/mapdl_commands/session/files.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
.. _ref_files_commands_api:

*****
.. _ref_files:


Files
*****
=====


.. currentmodule:: ansys.mapdl.core
.. currentmodule:: ansys.mapdl.core._commands.session.files

These SESSION commands are for file operations, such as deleting,
copying, and listing.
.. autoclass:: ansys.mapdl.core._commands.session.files.Files

.. autosummary::
:toctree: _autosummary/

Mapdl.anstoaqwa
Mapdl.anstoasas
Mapdl.assign
Mapdl.copy
Mapdl.slashdelete
Mapdl.fcomp
Mapdl.lgwrite
Mapdl.starlist
Mapdl.slashclog
Mapdl.slashfdele
Mapdl.rename
:template: base.rst
:toctree: _autosummary


Files.anstoaqwa
Files.anstoasas
Files.assign
Files.copy
Files.fclean
Files.fcomp
Files.lgwrite
Files.slashclog
Files.slashdelete
Files.slashfdele
Files.slashrename
Files.starlist
22 changes: 22 additions & 0 deletions doc/source/mapdl_commands/session/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

.. _ref_session:

Session
=======

.. list-table::

* - :ref:`ref_run_controls`
* - :ref:`ref_processor_entry`
* - :ref:`ref_files`
* - :ref:`ref_list_controls`


.. toctree::
:maxdepth: 1
:hidden:

run_controls
processor_entry
files
list_controls
29 changes: 17 additions & 12 deletions doc/source/mapdl_commands/session/list_controls.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
.. _ref_list_controls_commands_api:

*************
List controls
*************
.. _ref_list_controls:

.. currentmodule:: ansys.mapdl.core

These SESSION commands are used to control listings and printed program output.
ListControls
============


.. currentmodule:: ansys.mapdl.core._commands.session.list_controls

.. autoclass:: ansys.mapdl.core._commands.session.list_controls.ListControls

.. autosummary::
:toctree: _autosummary/
:template: base.rst
:toctree: _autosummary


Mapdl.com
Mapdl.golist
Mapdl.gopr
Mapdl.nolist
Mapdl.nopr
ListControls.com
ListControls.golist
ListControls.gopr
ListControls.nolist
ListControls.nopr
ListControls.slashgo
37 changes: 18 additions & 19 deletions doc/source/mapdl_commands/session/processor_entry.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
.. _ref_processor_entry_commands_api:

***************
Processor entry
***************
.. _ref_processor_entry:

.. currentmodule:: ansys.mapdl.core

These SESSION commands are used to enter and exit the various processors in the program.
ProcessorEntry
==============


.. currentmodule:: ansys.mapdl.core._commands.session.processor_entry

.. autoclass:: ansys.mapdl.core._commands.session.processor_entry.ProcessorEntry

.. autosummary::
:toctree: _autosummary/

Mapdl.aux2
Mapdl.aux3
Mapdl.aux12
Mapdl.aux15
Mapdl.finish
Mapdl.map
Mapdl.post1
Mapdl.post26
Mapdl.prep7
Mapdl.quit
Mapdl.slashsolu
:template: base.rst
:toctree: _autosummary


ProcessorEntry.finish
ProcessorEntry.post1
ProcessorEntry.post26
ProcessorEntry.prep7
ProcessorEntry.quit
ProcessorEntry.slashsolu
54 changes: 30 additions & 24 deletions doc/source/mapdl_commands/session/run_controls.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
.. _ref_run_controls_commands_api:

************
Run controls
************
.. _ref_run_controls:

.. currentmodule:: ansys.mapdl.core

These SESSION commands control the overall characteristics of the
session, including the job name, Graphical User Interface behavior, and
file switching.
RunControls
===========


.. currentmodule:: ansys.mapdl.core._commands.session.run_controls

.. autoclass:: ansys.mapdl.core._commands.session.run_controls.RunControls

.. autosummary::
:toctree: _autosummary/

Mapdl.config
Mapdl.cwd
Mapdl.exit
Mapdl.filname
Mapdl.input
Mapdl.keyw
Mapdl.memm
Mapdl.nerr
Mapdl.pause
Mapdl.slashstatus
Mapdl.starstatus
Mapdl.syp
Mapdl.sys
Mapdl.unpause
:template: base.rst
:toctree: _autosummary


RunControls.config
RunControls.cwd
RunControls.filname
RunControls.input
RunControls.keyw
RunControls.memm
RunControls.menu
RunControls.mstart
RunControls.nerr
RunControls.output
RunControls.pause
RunControls.slashexit
RunControls.slashstatus
RunControls.syp
RunControls.sys
RunControls.ui
RunControls.uis
RunControls.unpause
7 changes: 6 additions & 1 deletion src/ansys/mapdl/core/_commands/session/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,9 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

from . import files, list_controls, processor_entry, run_controls
from . import (
files,
list_controls,
processor_entry,
run_controls,
)
Loading
Loading