Skip to content

Commit

Permalink
change extension
Browse files Browse the repository at this point in the history
  • Loading branch information
otvam committed Apr 28, 2024
1 parent 987b6b6 commit 2cab289
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
20 changes: 10 additions & 10 deletions docs/content/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ Mesher: Building and Meshing the Geometry
# Run the mesher
# - geometry.yaml - contains the geometry description (input)
# - voxel.gz - contains the meshed voxel structure (output)
# - voxel.json.gz - contains the meshed voxel structure (output)
pypeec mesher \
--geometry tutorial/geometry.yaml \
--voxel tutorial/voxel.gz
--voxel tutorial/voxel.json.gz
.. literalinclude:: ../tutorial/log_mesher.txt
:language: text
Expand All @@ -47,11 +47,11 @@ Viewer: Plot the Geometry and Mesh
.. code-block:: bash
# Run the viewer
# - voxel.gz - contains the meshed voxel structure (input)
# - voxel.json.gz - contains the meshed voxel structure (input)
# - viewer.yaml - contains the plot configuration (input)
# - tag_plot - list of plots to be shown (defined in viewer.yaml)
pypeec viewer \
--voxel tutorial/voxel.gz \
--voxel tutorial/voxel.json.gz \
--viewer config/viewer.yaml \
--tag_plot domain connection
Expand All @@ -69,15 +69,15 @@ Solver: Solve the PEEC Problem
.. code-block:: bash
# Run the solver
# - voxel.gz - contains the meshed voxel structure (input)
# - voxel.json.gz - contains the meshed voxel structure (input)
# - problem.yaml - contains the magnetic problem description (input)
# - tolerance.yaml - contains the solver numerical tolerances (input)
# - solution.gz - contains the problem solution (output)
# - solution.json.gz - contains the problem solution (output)
pypeec solver \
--voxel tutorial/voxel.gz \
--voxel tutorial/voxel.json.gz \
--problem tutorial/problem.yaml \
--tolerance config/tolerance.yaml \
--solution tutorial/solution.gz
--solution tutorial/solution.json.gz
.. literalinclude:: ../tutorial/log_solver.txt
:language: text
Expand All @@ -88,11 +88,11 @@ Plotter: Plot the Solution
.. code-block:: bash
# Run the plotter
# - solution.gz - contains the problem solution (input)
# - solution.json.gz - contains the problem solution (input)
# - plotter.yaml - contains the plot configuration (input)
# - tag_plot - list of plots to be shown (defined in plotter.yaml)
pypeec plotter \
--solution tutorial/solution.gz \
--solution tutorial/solution.json.gz \
--plotter config/plotter.yaml \
--tag_plot V_c_abs J_c_norm H_norm residuum
Expand Down
2 changes: 1 addition & 1 deletion examples/run_mesher.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
if __name__ == "__main__":
# get the filenames
file_geometry = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "geometry.yaml")
file_voxel = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "voxel.gz")
file_voxel = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "voxel.json.gz")

# run
try:
Expand Down
2 changes: 1 addition & 1 deletion examples/run_plotter.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

if __name__ == "__main__":
# get the filenames
file_solution = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "solution.gz")
file_solution = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "solution.json.gz")
file_plotter = os.path.join(PATH_ROOT, FOLDER_CONFIG, "plotter.yaml")

# plot tag (from plotter.yaml)
Expand Down
4 changes: 2 additions & 2 deletions examples/run_solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
if __name__ == "__main__":
# get the filenames
file_problem = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "problem.yaml")
file_voxel = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "voxel.gz")
file_solution = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "solution.gz")
file_voxel = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "voxel.json.gz")
file_solution = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "solution.json.gz")
file_tolerance = os.path.join(PATH_ROOT, FOLDER_CONFIG, "tolerance.yaml")

# run
Expand Down
2 changes: 1 addition & 1 deletion examples/run_viewer.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

if __name__ == "__main__":
# get the filenames
file_voxel = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "voxel.gz")
file_voxel = os.path.join(PATH_ROOT, FOLDER_EXAMPLE, "voxel.json.gz")
file_viewer = os.path.join(PATH_ROOT, FOLDER_CONFIG, "viewer.yaml")

# plot tag (from viewer.yaml)
Expand Down

0 comments on commit 2cab289

Please sign in to comment.