Skip to content

Commit

Permalink
Merge pull request #742 from ansys/docs/windows_path_warning
Browse files Browse the repository at this point in the history
Added danger hint when using windows paths
  • Loading branch information
SRaimondi authored Dec 19, 2024
2 parents 80f16ca + fd0c8cb commit e1c4808
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ The following example imports a CDB file.
See :class:`.FeFormat` for a list of supported FE formats. Check out the
:ref:`input_file_for_pyacp` section to see how input files can be created.

.. danger::
When working on Windows, be careful of backslashes in paths: These may correspond to
`escape sequences <https://docs.python.org/3/reference/lexical_analysis.html#escape-sequences>`_, resulting in errors.
To avoid issues, make sure to quote the backslashes (by using ``\\``) or use a
`raw string literal <https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals>`_ by prefixing your string with **r**,
like ``model = acp.import_model(r"path\to\your\model.acph5")``.


Start modelling
~~~~~~~~~~~~~~~
Expand Down

0 comments on commit e1c4808

Please sign in to comment.