Skip to content

MartiDvrk/opengate

 
 

Repository files navigation

GitHub tag (latest by date) CI cirrus CI Read the Docs pre-commit.ci status Binder

This is the future GATE version 10. First release is expected 1S 2023.

How to install (short version)

First create an environment (not mandatory but highly advised)

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

Warning not available for python 3.11 yet.

Then install the package opengate. The package opengate_core is automatically downloaded.

pip install opengate

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

pip install opengate -U

Once installed, you can run all tests:

opengate_tests

All tests are in the folder here. Some data (binary files) are stored, for technical reasons, in this git: https://gitlab.in2p3.fr/opengate/tests_data (which is stored as a git submodule).

WARNING some tests (e.g. test034) needs gaga-phsp which needs pytorch 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

Releases

No releases published

Packages

No packages published

Languages

  • Python 49.1%
  • C++ 42.3%
  • Bikeshed 8.2%
  • Other 0.4%