Merge branch 'main' into chore/setup-ruff

Author: ecoussoux-ansys

doc/source/archive.rst

@@ -0,0 +1,49 @@
+.. _archive:
+
+Legacy DotNet API (Archived)
+=============================
+
+.. danger::
+
+   **The ``pyedb.dotnet`` module is deprecated and archived.**
+   Maintenance is planned to be dropped starting Ansys 2026R1 release. All users are **strongly encouraged** to
+migrate to the modern :ref:`gRPC-based client <comms_protocols>`, which is the future of PyEDB.
+
+What Was the DotNet API?
+------------------------
+The ``pyedb.dotnet`` module was the original implementation of PyEDB. It was a Python wrapper around the Ansys
+EDB DotNet code.
+
+This approach was limited to DotNet framework causing incompatibility issues on non-Windows platforms.
+
+Why It Was Replaced
+-------------------
+The new architecture, based on a standalone gRPC service (``ansys-edb-core``), provides significant advantages:
+
+*   **Cross-Platform:** The client can run on **Linux, and Windows**.
+*   **Headless Operation:** Ideal for servers, Docker, and CI/CD pipelines.
+*   **Better Performance:** The gRPC protocol is more efficient.
+*   **Modern and Maintainable:** The codebase is cleaner and easier to extend.
+
+Accessing the Archived Code
+---------------------------
+The code for the deprecated ``dotnet`` module has been moved to a separate, archived branch in the GitHub repository
+to avoid confusion and keep the main branch clean.
+
+**You can access the final version of the `dotnet` code here:**
+
+.. toctree::
+   :maxdepth: 2
+
+   dotnet_api/index
+
+.. warning::
+
+   This code is provided **as-is** for reference and migration purposes only. Do not use it for
+new projects. If you need to maintain an old script that uses the ``dotnet`` API, your goal should be to migrate it to
+the gRPC client.
+
+Migration Guide
+---------------
+If you have existing scripts using `pyedb.dotnet`, see the :doc:`migration_guide` for help porting your code to the
+modern gRPC API.

doc/source/build_breaking_change.rst

@@ -0,0 +1,34 @@
+Changelog
+=========
+
+All notable changes to PyEDB are documented in this file.
+
+The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
+and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+[Unreleased]
+------------
+### Added
+-
+
+### Changed
+-
+
+### Deprecated
+-
+
+### Fixed
+-
+
+### Removed
+-
+
+[0.9.0] - 2024-XX-YY
+--------------------
+### Added
+- Initial release of the gRPC-based PyEDB client.
+- Comprehensive documentation including user guides, migration guide, and examples.
+- Core functionality for EDB creation, modification, and simulation setup.
+
+### Removed
+- Legacy `pyedb.dotnet` module (moved to archived branch).

doc/source/changelog.rst

@@ -0,0 +1,67 @@
+Contribution Guide
+==================
+
+All contributions to PyEDB are welcome. This guide helps you get started.
+
+Development Environment Setup
+-----------------------------
+1.  Fork the `PyEDB repository <https://github.com/ansys/pyedb>`_ on GitHub.
+2.  Clone your fork locally:
+
+    .. code-block:: bash
+
+        git clone https://github.com/your-username/pyedb.git
+        cd pyedb
+
+3.  Install the package in development mode with all dependencies:
+
+    .. code-block:: bash
+
+        pip install -e ".[dev]"
+
+4.  Install pre-commit hooks to ensure code quality:
+
+    .. code-block:: bash
+
+        pre-commit install
+
+Running Tests
+-------------
+To ensure your changes don't break existing functionality, run the test suite:
+
+.. code-block:: bash
+
+    pytest tests/ -v
+
+Building Documentation
+----------------------
+To build and preview the documentation locally:
+
+.. code-block:: bash
+
+    cd doc
+    make html
+    # Open _build/html/index.html in your browser
+
+Submission Process
+------------------
+1.  Create a branch for your feature or bug fix: `git checkout -b feature/your-feature-name`
+2.  Make your changes and add tests.
+3.  Ensure all tests pass and pre-commit checks are satisfied.
+4.  Commit your changes: `git commit -m "Add feature: your feature description"`
+5.  Push to your fork: `git push origin feature/your-feature-name`
+6.  Open a Pull Request against the main PyEDB repository.
+
+Code Style
+----------
+*   Follow `PEP 8 <https://pep8.org/>`_ guidelines.
+*   Use Google-style docstrings for all public functions and classes.
+*   Include type hints for all function parameters and return values.
+
+Documentation Contributions
+---------------------------
+When adding new features, please also update the relevant documentation:
+
+*   Add examples to the appropriate section in `user_guide/common_tasks.rst`.
+*   Create a new Jupyter notebook in `doc/notebooks/` if the feature warrants a comprehensive example.
+*   Ensure all new public API elements have proper docstrings.

doc/source/contributing.rst

@@ -0,0 +1,45 @@
+Examples
+========
+
+High-Frequency Layout Examples (PyAEDT + PyEDB)
+-----------------------------------------------
+
+These examples show how PyEDB and PyAEDT work together to create solve and post-process high-frequency PCB/IC packages and RF boards.
+They are maintained in the main PyAEDT example gallery and include:
+
+* Import and modification of EDB layout
+* HFSS 3-D and HFSS 3-D Layout set-ups
+* Frequency sweeps, field plots, S-parameter export
+* Parametric studies and optimization loops
+
+.. raw:: html
+
+   <div style="margin-bottom:1.5em;">
+     <a class="reference external"
+        href="https://examples.aedt.docs.pyansys.com/version/dev/examples/high_frequency/layout/index.html">
+        <button style="background:#0076CE;color:white;border:0;border-radius:4px;padding:.6em 1em;margin-right:.5em">
+          📖 Browse Examples
+        </button>
+     </a>
+
+     <a class="reference external"
+        href="https://github.com/ansys/pyaedt-examples/tree/main/examples/high_frequency/layout">
+        <button style="background:#24292f;color:white;border:0;border-radius:4px;padding:.6em 1em">
+          📁 View on GitHub
+        </button>
+     </a>
+   </div>
+
+Feel free to open an issue or pull request if you would like to add new PyEDB-focused examples to this collection.
+
+This examples are focused on using PyEDB to create, modify, and analyze PCB/IC packages and RF boards. The basic
+section covers fundamental tasks, while the advanced section demonstrates more complex workflows for Si-PI.
+
+PyEDB basic and advanced examples
+=================================
+
+.. toctree::
+   :maxdepth: 1
+
+   basic/index
+   advanced/index