Metadata-Version: 2.1
Name: roxieinterfaces
Version: 0.2.2
Summary: Interfaces implementation to roxie
Home-page: https://roxie.docs.cern.ch/
License: BSD-4-Clause
Author: Matthias Bonora
Author-email: matthias.bonora@cern.ch
Requires-Python: >=3.9,<4.0
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: BSD License
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: gmsh (>=4.11.1,<5.0.0)
Requires-Dist: pyvista (>=0.43.5,<0.44.0)
Requires-Dist: roxie-api (>=0.3,<0.4)
Requires-Dist: scipy (>=1.13.0,<2.0.0)
Requires-Dist: trame-vtk (>=2.8.6,<3.0.0)
Project-URL: Documentation, https://roxie-interfaces.docs.cern.ch/
Project-URL: Repository, https://gitlab.cern.ch/te-msc-mm/templates/python-package-template
Description-Content-Type: text/markdown

[//]: # "Comment" SPDX-FileCopyrightText: 2024 CERN
[//]: # "Comment" SPDX-License-Identifier: BSD-4-Clause

# Roxie Interfaces

This project provides python tools and classes to interface with Roxie.

See [The Roxie documentation](https://roxie.docs.cern.ch/) on how to install Roxie binaries.

## Installation

### As pip package

Simply install the package via pip:

    pip install roxie-interfaces

### Via Poetry

We use the poetry packaging manager. You can get poetry with pip:

    pip install poetry

After You have pulled this repository with git. Navigate to the main directory (where this readme file is located),
and run

    poetry install

## Features

### Step file generation (conductors and end spacers)

The most important example is plot_step_file_generation.
It shows You how to generate the step files for endspacers, wedges, posts and conductors.

### HMO file generator

Load mesh formats (hmascii, gmsh) and generate hmo file to use with roxie.

