Metadata-Version: 2.3
Name: snoopy-SHiP
Version: 0.1.2
Summary: 
Author: meliebsc
Author-email: melvin.liebsch@cern.ch
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: gmsh (>=4.13.1,<5.0.0)
Requires-Dist: ipykernel (>=6.29.5,<7.0.0)
Requires-Dist: matplotlib (>=3.10.0,<4.0.0)
Requires-Dist: myst-parser (>=4.0.0,<5.0.0)
Requires-Dist: networkx (>=3.4.2,<4.0.0)
Requires-Dist: numpy (>=2.2.1,<3.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: plotly (>=6.0.0,<7.0.0)
Requires-Dist: pydata-sphinx-theme (>=0.16.1,<0.17.0)
Requires-Dist: pyqt6 (>=6.8.0,<7.0.0)
Requires-Dist: pyvista (>=0.44.2,<0.45.0)
Requires-Dist: scipy (>=1.14.1,<2.0.0)
Requires-Dist: sphinx (>=8.1.3,<9.0.0)
Requires-Dist: sphinx-gallery (>=0.18.0,<0.19.0)
Requires-Dist: sphinxcontrib-apidoc (>=0.5.0,<0.6.0)
Requires-Dist: tqdm (>=4.67.1,<5.0.0)
Description-Content-Type: text/markdown

# The snoo.py package
The snoo.py package is a leightweight but efficient finite element method based on gmsh and scipy.
It has been developed to provide field maps for the optimization of a muon shield at CERN.

# Installation

The easiest way to use snoo.py is to install it in pip. Simply run

pip install snoopy-SHiP

The second option is by using poetry. Just clone this repository and run

poetry build
poetry install

Thats it!

# Requirements

It is important that You have python dev installed. In Ubuntu You get it like this:

sudo apt-get install python3-dev

In CentOS You get it like this:

sudo yum install python3-devel

This package is based on python3.11.

# Getting started.

There is an examples folder in the root directory. Also, You can generate autodocs
by running:

poetry run make html

in the docs directory.
This will also generate the examples gallery.
