add template (#215)

* add template

* Minor updates

Minor update to README.md and template.py

---------

Co-authored-by: Devin <devin.crawford@ansys.com>
Co-authored-by: Samuel Lopez <85613111+Samuelopez-ansys@users.noreply.github.com>

Author: 3 people

README.md

@@ -37,10 +37,17 @@ The following guidelines help ensure that the examples are consistent, easy to r
   ```
      temp_dir.cleanup()
   ```
-- The examples should be formatted, so they are compatible with jupytext using the [light format](https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format) and can
-be rendered and run in [Jupyter Lab](https://docs.jupyter.org/en/latest/) as Notebook files. Jupyter can be used to ensure correct rendering of markdown, images, and equations.
+- The examples should be formatted, so they are compatible with 
+  [jupytext](https://jupytext.readthedocs.io/en/latest/) using the [light format](https://jupytext.readthedocs.io/en/latest/formats-scripts.html#the-light-format) and can
+  be rendered and run in [Jupyter Lab](https://docs.jupyter.org/en/latest/) as Notebook files. Jupyter can be used to ensure correct
+  rendering of markdown, images, and equations.
   ```
      pip install .[doc]
      jupyter lab
   ```
-  Notebook files can be opened, edited and run from within Jupyter using _right click > Open With > Jupytext Notebook_.
+- You can use this [template](./examples/template.py) to help you start creating a new example 
+  for publication here.
+
+  If you're creating an example for publication here, you can open
+  the file and render it from within Jupyter  
+  using _right click > Open With > Jupytext Notebook_.

examples/template.py

@@ -0,0 +1,82 @@
+# # Short, Descriptive Title (do not specify the application name here, i.e.: Maxwell2D, Maxwell3D etc)
+#
+# Description:
+#
+# Most examples can be described as a series of steps that comprise a workflow.
+# 1. Import packages and instantiate the application.
+# 2. Do something useful and interesting.
+# 3. View the results.
+#
+# Keywords: **Template**, **Jupyter**
+
+# ## Perform required imports
+#
+# Perform required imports.
+
+import os
+import tempfile
+import time
+
+import ansys.aedt.core
+
+# ## Define constants
+
+AEDT_VERSION = "2024.2"
+NUM_CORES = 4
+NG_MODE = False  # Open Electronics UI when the application is launched.
+
+# ## Create temporary directory
+#
+# Create temporary directory.
+# If you'd like to retrieve the project data for subsequent use,
+# the temporary folder name is given by ``temp_folder.name``.
+
+temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")
+
+# ## Launch AEDT and application
+#
+# Create an instance of the application (i.e. ``Maxwell3d``,``Hfss`` etc)
+# class named (``m3d``,``hfss`` etc.) by providing
+# the project and design names, the solver, and the version.
+
+project_name = os.path.join(temp_folder.name, "my_project.aedt")
+m3d = ansys.aedt.core.Maxwell3d(
+    project=project_name,
+    design="my_design",
+    solution_type="my_solver",
+    version=AEDT_VERSION,
+    non_graphical=NG_MODE,
+    new_desktop=True,
+)
+m3d.modeler.model_units = "mm"
+
+# ## Pre-Processing
+#
+# Description of pre-processing task.
+# Add as many sections as needed for pre-processing tasks.
+
+
+
+# ## Post-Processing
+#
+# Description of post-processing task.
+# Add as many sections as needed for post-processing tasks.
+
+
+
+
+# ## Release AEDT
+
+m3d.save_project()
+m3d.release_desktop()
+# Wait 3 seconds to allow Electronics Desktop to shut down before cleaning the temporary directory.
+time.sleep(3)
+
+# ## Cleanup
+#
+# All project files are saved in the folder ``temp_dir.name``.
+# If you've run this example as a Jupyter notebook you
+# can retrieve those project files. The following cell
+# removes all temporary files, including the project folder.
+
+temp_folder.cleanup()