Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added danger hint when using windows paths #742

Merged
merged 5 commits into from
Dec 19, 2024
Merged

Added danger hint when using windows paths #742

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b4a42ba
Added warning comment
SRaimondi Dec 17, 2024
c3d1dd3
Changed to danger directive
SRaimondi Dec 17, 2024
e6467a0
Added links to documentation, minor changes
SRaimondi Dec 18, 2024
4e7e5ce
Update doc/source/intro.rst
SRaimondi Dec 18, 2024
fd0c8cb
Merge branch 'main' into docs/windows_path_warning
SRaimondi Dec 19, 2024
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
5 changes: 5 additions & 0 deletions doc/source/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ 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 possible **escape sequences** in paths that could result in errors.
SRaimondi marked this conversation as resolved.
Show resolved Hide resolved
To avoid issues, make sure to quote the backslashes in your path or use a *raw string literal* by prefixing your string with **r**,
like ``model = acp.import_model(r"path\to\your\model.acph5")``.


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