Metadata-Version: 2.1
Name: opengate
Version: 10.0b3
Summary: Simulation for Medical Physics
Home-page: https://github.com/OpenGATE/opengate
Author: Opengate collaboration
Author-email: david.sarrut@creatis.insa-lyon.fr
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: colored
Requires-Dist: opengate-core (==10.0beta03)
Requires-Dist: gatetools
Requires-Dist: tqdm
Requires-Dist: click
Requires-Dist: python-box (<7.0.0)
Requires-Dist: anytree
Requires-Dist: numpy
Requires-Dist: itk
Requires-Dist: uproot
Requires-Dist: sphinx
Requires-Dist: scipy
Requires-Dist: sphinx-pdj-theme
Requires-Dist: matplotlib
Requires-Dist: myst-parser
Requires-Dist: GitPython
Requires-Dist: colorlog
Requires-Dist: sphinx-copybutton
Requires-Dist: autoapi
Requires-Dist: sphinx-autoapi

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/OpenGATE/opengate?logo=github)
[![CI](https://github.com/OpenGATE/opengate/actions/workflows/main.yml/badge.svg)](https://github.com/OpenGATE/opengate/actions/workflows/main.yml)
[![cirrus CI](https://api.cirrus-ci.com/github/OpenGATE/opengate.svg)](https://cirrus-ci.com/github/OpenGATE/opengate)
[![Read the Docs](https://img.shields.io/readthedocs/opengate-python?logo=read-the-docs&style=plastic)](https://opengate-python.readthedocs.io/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/OpenGATE/opengate/master.svg)](https://results.pre-commit.ci/latest/github/OpenGATE/opengate/master)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/OpenGATE/gam-gate/c65a0d55c616748454f066470aa836331eb107ac)

See the [User Guide](https://opengate-python.readthedocs.io/en/latest/user_guide.html).

# How to install (short version)

First create an environment (not mandatory but highly advised)

```
python -m venv opengate_env
source opengate_env/bin/activate
```

or you can use the conda environment.

```
conda create --name opengate_env python=3.9
conda activate opengate_env
```

**Warning** not available for MacOS Intel with python 3.11 yet.

Then install the package opengate. The package opengate_core is automatically downloaded. opengate_core installs Geant4 v11.1.1 librairies.
```
pip install --upgrade pip
pip install --pre opengate
```

If you already installed the packages and want to upgrade to last version:

```
pip install --upgrade --pre opengate
```

Once installed, you can run all tests:
````
opengate_tests
````

All tests are in the folder [here](https://github.com/OpenGATE/opengate/tree/master/opengate/tests/src). Some data (binary files) are stored, for technical reasons, in this git: https://gitlab.in2p3.fr/opengamgate/gam_tests_data (which is stored as a git submodule).

**WARNING** some tests (e.g. test034) needs [gaga-phsp](https://github.com/dsarrut/gaga-phsp) which needs [pytorch](https://pytorch.org/) that cannot really be automatically installed by the previous pip install (at least we dont know how to do). So, in order to run those tests, you will have to install both pytorch and gaga-phsp first with
````
pip install torch
pip install gaga-phsp
````

The documentation is here: https://opengate-python.readthedocs.io/en/latest/user_guide.html

# How to install (long version, for developers)

See the documentation : https://opengate-python.readthedocs.io/en/latest/developer_guide.html#installation-for-developers

WARNING : need [Geant4 11.1.1](https://geant4.web.cern.ch/download/11.1.1.html)


