|
1 | 1 | # IDEAL |
2 | | -**I**ndependent **D**os**E** c**A**lculation for **L**ight ion beam therapy using Geant4/GATE. Also known as `pyidc`. |
| 2 | +**I**ndependent **D**os**E** c**A**lculation for **L**ight ion beam therapy using Geant4/GATE. |
3 | 3 |
|
4 | | -This is the `1.0` release of the IDEAL project. This was developed between |
5 | | -February 2018 and March 2021 at [EBG MedAustron GmbH](https://www.medaustron.at/), in collaboration with |
| 4 | +This is the `1.1` release of the IDEAL project. The project was initiated in |
| 5 | +2018 at [EBG MedAustron GmbH](https://www.medaustron.at/), in collaboration with |
6 | 6 | [ACMIT Gmbh](https://acmit.at/) and the [Medical University of Vienna](https://radioonkologie.meduniwien.ac.at/research/research-activities/). |
| 7 | + |
| 8 | +What's new in release `1.1`: |
| 9 | +- **API interface**: simulations can be started in IDEAL from a remote (or local) client via http or https communication. IDEAL will send the results back to the client. |
| 10 | +- **python module**: you can now easily start simulations via python scripting and retrieve info on the DICOM data. |
| 11 | +- you can **keep track of all the simulation** started in IDEAL, with date, working and output directories and simulation status. |
| 12 | + |
7 | 13 | This code has been tested to work correctly for treatment plans with the fixed beam lines of the |
8 | 14 | MedAustron clinic. At the time of this release it has not yet been tested at any other clinic, but we hope |
9 | 15 | that this software will be useful at other clinics as well. |
10 | 16 |
|
11 | | -If you wish to install this `1.0` release, please clone this code directly from |
| 17 | +If you wish to install this `1.1` release, please clone this code directly from |
12 | 18 | GitHub on a shared disk of the submit node of your HTCondor cluster and follow |
13 | | -the installation instructions. In order to facilitate installation with `pip`, |
14 | | -the code will be reorganized a git, in particular the `ideal` module will |
15 | | -effectively be renamed `pyidc` in order to avoid a name collision with an |
16 | | -existing (but currently unmaintained) "iDEAL" python module. This will then be released as a `1.1` release. |
| 19 | +the installation instructions. |
17 | 20 |
|
18 | | -This project will not work until it has been properly configured, regardless of |
19 | | -whether you install this project by cloning or with `pip install pyidc` (`1.1` and later). |
| 21 | +This project will not work until it has been properly configured. |
20 | 22 | Please take your time and read the ["installation"](https://pyidc.readthedocs.io/en/latest/installation/index.html) |
21 | 23 | and ["commissioning"](https://pyidc.readthedocs.io/en/latest/commissioning/index.html) sections of the documentation carefully. |
| 24 | +For instructions on how to use IDEAL and its different user interfaces, check the ["user manual"](https://pyidc.readthedocs.io/en/latest/usage/index.html#) section of the documentation. |
0 commit comments