Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OpenGATE/opengate
Gate 10 (beta)
https://github.com/OpenGATE/opengate
medical-physics monte-carlo-simulation physics-simulation python
Last synced: 3 months ago
JSON representation
Gate 10 (beta)
- Host: GitHub
- URL: https://github.com/OpenGATE/opengate
- Owner: OpenGATE
- License: lgpl-3.0
- Created: 2021-11-29T10:40:14.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T09:40:37.000Z (5 months ago)
- Last Synced: 2024-05-29T01:07:53.813Z (5 months ago)
- Topics: medical-physics, monte-carlo-simulation, physics-simulation, python
- Language: Python
- Homepage: http://www.opengatecollaboration.org
- Size: 8.57 MB
- Stars: 37
- Watchers: 8
- Forks: 37
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-medphys - opengate -  GATE is an advanced opensource software developed by the international OpenGATE collaboration and dedicated to numerical simulations in medical imaging and radiotherapy. GATE is based on the Geant4 toolkit.  (Libraries)
README
[](https://opengate-python.readthedocs.io/)
[](https://github.com/OpenGATE/opengate/actions/workflows/main.yml)
[](https://cirrus-ci.com/github/OpenGATE/opengate)
[](https://results.pre-commit.ci/latest/github/OpenGATE/opengate/master)
## This is GATE10 **beta** version. The first non-beta release will be officially announced in the summer 2024.
See the [User Guide](https://opengate-python.readthedocs.io/en/latest/user_guide.html). The current version uses [Geant4 11.2.1](https://geant4.web.cern.ch).
### How to install (short version)
*Compatible with Python 3.8, 3.9, 3.10, 3.11. Not available for Python 3.12 yet. On Windows multithreading, Qt visualization and the "spawn new subprocess" are not (yet) available.*
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
```
Then install the package opengate. The package ```opengate_core``` is automatically downloaded. ```opengate_core``` installs Geant4 librairies.
```
pip install --upgrade pip
pip install --pre opengate
```
If you already installed the packages and want to upgrade to the latest version:
```
pip install --upgrade --pre opengate
```
Once installed, you can run all tests:
````
opengate_tests
````
**WARNING** The first time you run this command, the test data will be downloaded. If the download fails (on some systems), try to add the following command before running opengate_tests:
````
export GIT_SSL_NO_VERIFY=1
````
All tests are in the folder [here](https://github.com/OpenGATE/opengate/tree/master/opengate/tests/src). The test 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 don't 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