... | @@ -11,15 +11,16 @@ The codebase is hosted by the University of Namur. We are open to granting acces |
... | @@ -11,15 +11,16 @@ The codebase is hosted by the University of Namur. We are open to granting acces |
|
|
|
|
|
## General description
|
|
## General description
|
|
|
|
|
|
This python3 module allows you to perform radiobiology related simulations. The embedded
|
|
This python3 module allows you to perform radiobiology-related simulations. The embedded
|
|
science (all Physics, Chemistry & Biology) has the purpose to solve systems of Ordinary
|
|
science, which includes physics, chemistry, and biology, aims to solve systems of
|
|
Differential Equations (a.k.a. ODE) based on equations provided via an input file.
|
|
Ordinary Differential Equations (ODE) based on equations provided via an input file.
|
|
The default solver is the LSODA solver from the good
|
|
The default solver used in this module is the LSODA solver from the
|
|
[scipy](https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.solve_ivp.html)
|
|
[scipy](https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.solve_ivp.html)
|
|
module.
|
|
module.
|
|
|
|
|
|
|
|
### Forewords
|
|
|
|
|
|
This documentation assumes you already have or know how to install a new python3
|
|
The following documentation assumes you already have or know how to install a new python3
|
|
environment on your local machine. If it is not yet the case, We suggest to check
|
|
environment on your local machine. If it is not yet the case, We suggest to check
|
|
[this](https://www.anaconda.com/) out.
|
|
[this](https://www.anaconda.com/) out.
|
|
|
|
|
... | @@ -32,7 +33,8 @@ Currently the main dependencies of this module are: |
... | @@ -32,7 +33,8 @@ Currently the main dependencies of this module are: |
|
- lark
|
|
- lark
|
|
- more-itertools
|
|
- more-itertools
|
|
|
|
|
|
For JupyterLab user, think to also install (to have nice progressbar):
|
|
For JupyterLab users, it is also suggested to install the following packages for a
|
|
|
|
better experience:
|
|
|
|
|
|
- tqdm
|
|
- tqdm
|
|
- jupyterlab-widgets
|
|
- jupyterlab-widgets
|
... | @@ -49,7 +51,7 @@ ps: Needless to say that Python2 is forbidden... |
... | @@ -49,7 +51,7 @@ ps: Needless to say that Python2 is forbidden... |
|
pps: There is currently no code coverage (tests)... a big problem to solve.
|
|
pps: There is currently no code coverage (tests)... a big problem to solve.
|
|
|
|
|
|
|
|
|
|
### Wiki Navigation
|
|
## Wiki Navigation
|
|
|
|
|
|
[Getting Started](/Getting-Started)
|
|
[Getting Started](/Getting-Started)
|
|
[Configuration File](/Getting-Started/Configuration-Files)
|
|
[Configuration File](/Getting-Started/Configuration-Files)
|
... | | ... | |