Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
psimpy
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
mbd
psimpy
Commits
0645aad9
Commit
0645aad9
authored
2 years ago
by
Hu Zhao
Browse files
Options
Downloads
Patches
Plain Diff
docs: add installation info
parent
f97bcb27
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+61
-1
61 additions, 1 deletion
README.md
with
61 additions
and
1 deletion
README.md
+
61
−
1
View file @
0645aad9
...
@@ -7,9 +7,69 @@ efficiently inverstigating uncertainties associated with physics-based models
...
@@ -7,9 +7,69 @@ efficiently inverstigating uncertainties associated with physics-based models
## Installation
## Installation
To be input soon...
`PSimPy`
is a pure Python package and can be easily installed using
`pip`
. All
Python-related dependencies are automatically taken care of. It should be noted
that some modules of
`PSimPy`
rely on / take advantage of non-Python package and
software. More specifically, the emulator module
`robustgasp.py`
relies on the R
package
`RobustGaSP`
; the simulator module
`ravaflow.py`
relies on the open
source software
`r.avaflow 2.4`
. If you want to use these modules or any other
modules relying on these modules, corresponding non-Python dependencies need to
be installed.
You can find how to install
`r.avaflow 2.4`
following its official documentation
under https://www.landslidemodels.org/r.avaflow/.
We recommond you to install
`PSimPy`
in a virtual environment such as a
`conda`
environment. You may want to first install
`Anaconda`
or
`Miniconda`
if you
haven't. The steps afterwards are as follows:
1.
Create a conda environment with Python 3.9:
```
bash
conda create
--name
your_env_name
python
=
3.9
```
2.
Install
`R`
if you don't have it on your machine
(if you have
`R`
, you can skip this step; alternatively, you can follow this step
to install
`R`
in the conda environment):
```
bash
conda activate your_env_name
conda
install
-c
conda-forge r-base
=
3.6
```
3.
Install the R package
`RobustGaSP`
in the R terminal:
```
bash
R
install.packages
(
"RobustGaSP"
,repos
=
"https://cran.r-project.org"
,version
=
"0.6.4"
)
q
()
```
4.
Configure the environment variable
`R_HOME`
so that
`rpy2`
knows where to find
`R`
packages. You can find the value of your
`R_HOME`
by typing the following
command in the R terminal:
```
bash
R.home
()
```
Then set
`R_HOME`
in your conda environment by
```
bash
conda
env
config vars
set
R_HOME
=
your_R_HOME_value
```
5.
Install
`PSimPy`
using
`pip`
in your conda environment by
```
bash
pip
install
psimpy
```
Now you should have
`PSimPy`
and its dependencies successfully installed.
## Usage
## Usage
Examples are currently in preparation and will be available soon in coming
versions. You may want to have a look at the tests which are currently available
at https://git-ce.rwth-aachen.de/mbd/psimpy. They give a glimpse of how
`PSimpy`
can be used.
## Documentation
Documentation is currently in preparation and will be available soon.
## License
## License
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment